Page Status: draft updated 2024-12-20
HVOOrganizationalUnit
Page index
Introduction
Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.
Overview
HVOOrganizationalUnit (Organization) | I | SEBaseOrganization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
HVOBusiness | S | 0..1 | Resource |
extension | I | 2..* | Extension |
organizationActive | S I | 1..1 | Extension(boolean) |
period | S I | 1..1 | Extension(Period) |
additionalRelationship | S I | 0..* | Extension(Complex) |
qualification | S I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ I | 1..* | Identifier |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uri |
value | S Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
hsaid | S Σ I | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBindingFixed Value |
system | S Σ | 1..1 | uriFixed Value |
value | S Σ I | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
organizationIdentifier | S Σ I | 0..0 | Identifier |
active | Σ ?! | 0..1 | boolean |
type | S Σ | 0..* | CodeableConceptBinding |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
careUnit | S Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | stringPattern |
code | S Σ | 1..1 | codePattern |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | S Σ I | 0..1 | string |
alias | S I | 0..* | string |
telecom | S I | 0..0 | ContactPoint |
address | S I | 0..0 | Address |
partOf | S Σ I | 1..1 | Reference(HVOOrganization) |
contact | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | S | 0..1 | CodeableConceptBinding |
name | S | 0..1 | HumanName |
telecom | S I | 0..* | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ I | 1..1 | codeBinding |
value | S Σ I | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | S Σ I | 1..1 | Period |
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | S Σ I | 1..1 | dateTime |
end | S Σ I | 0..1 | dateTime |
address | S | 0..1 | Address |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | S Σ I | 0..* | string |
city | S Σ I | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | S Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
endpoint | I | 0..* | Reference(Endpoint) |
Organization | |
Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Organization.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Organization.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Organization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Organization.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Organization.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Organization.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Slicing | Unordered, Open, by resourceType(Value) |
Mappings |
|
Organization.contained:HVOBusiness | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...1 |
Type | Resource |
Must Support | True |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Organization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.extension:organizationActive | |
Definition | The status which the organization is registered with in SCB:s Business Register (sv: Företagsregister), where true implies 'active' and false implies 'inactive'. |
Cardinality | 1...1 |
Type | Extension(boolean) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.extension:period | |
Definition | The date range that this organization should be considered available. |
Cardinality | 1...1 |
Type | Extension(Period) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.extension:additionalRelationship | |
Definition | Extension for Organization to supply potential relationships between organizations, for example that an organization owns or is owned by another organization. |
Cardinality | 0...* |
Type | Extension(Complex) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.extension:qualification | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.identifier | |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Cardinality | 1...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
Organization.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Organization.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Organization.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Organization.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Organization.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Organization.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Organization.identifier:hsaid | |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Cardinality | 0...1 |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:hsaid.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.identifier:hsaid.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.identifier:hsaid.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Organization.identifier:hsaid.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Fixed Value | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } ] } |
Mappings |
|
Organization.identifier:hsaid.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Fixed Value | urn:oid:1.2.752.29.4.19 |
Mappings |
|
Organization.identifier:hsaid.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Organization.identifier:hsaid.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Organization.identifier:hsaid.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Organization.identifier:organizationIdentifier | |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Cardinality | 0...0 |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:organizationIdentifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.identifier:organizationIdentifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.identifier:organizationIdentifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Organization.identifier:organizationIdentifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Fixed Value | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] } |
Mappings |
|
Organization.identifier:organizationIdentifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Fixed Value | urn:oid:2.5.4.97 |
Mappings |
|
Organization.identifier:organizationIdentifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Organization.identifier:organizationIdentifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Organization.identifier:organizationIdentifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Organization.active | |
Definition | Whether the organization's record is still in active use. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
Organization.type | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Slicing | Unordered, Open, by coding.code(Value) |
Invariants |
|
Mappings |
|
Organization.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Organization.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Organization.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Organization.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Organization.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Organization.type:careUnit | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Invariants |
|
Mappings |
|
Organization.type:careUnit.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.type:careUnit.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.type:careUnit.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct", "version": "http://snomed.info/sct/45991000052106", "code": "43741000" } |
Mappings |
|
Organization.type:careUnit.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.type:careUnit.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.type:careUnit.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Organization.type:careUnit.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Pattern | http://snomed.info/sct/45991000052106 |
Mappings |
|
Organization.type:careUnit.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | 43741000 |
Mappings |
|
Organization.type:careUnit.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.type:careUnit.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Organization.type:careUnit.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Organization.name | |
Definition | A name associated with the organization. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to use the name as the label of the organization. |
Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
Invariants |
|
Mappings |
|
Organization.alias | |
Definition | A list of alternate names that the organization is known as, or was known as in the past. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
Invariants |
|
Mappings |
|
Organization.telecom | |
Definition | A contact detail for the organization. |
Cardinality | 0...0 |
Type | ContactPoint |
Must Support | True |
Requirements | Human contact for the organization. |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Invariants |
|
Mappings |
|
Organization.address | |
Definition | An address for the organization. |
Cardinality | 0...0 |
Type | Address |
Must Support | True |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. |
Invariants |
|
Mappings |
|
Organization.partOf | |
Definition | The organization of which this organization forms a part. |
Cardinality | 1...1 |
Type | Reference(HVOOrganization) |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the hierarchy of organizations within an organization. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Organization.contact | |
Definition | Contact for the organization for a certain purpose. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Requirements | Need to keep track of assigned contact points within bigger organization. |
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. |
Invariants |
|
Mappings |
|
Organization.contact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.contact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.contact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.contact.purpose | |
Definition | Indicates a purpose for which the contact can be reached. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The purpose for which you would contact a contact party. |
Must Support | True |
Requirements | Need to distinguish between multiple contact persons. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Organization.contact.name | |
Definition | A name associated with the contact. |
Cardinality | 0...1 |
Type | HumanName |
Must Support | True |
Requirements | Need to be able to track the person by name. |
Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
Invariants |
|
Mappings |
|
Organization.contact.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.contact.telecom.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.contact.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 1...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.contact.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 1...1 |
Type | Period |
Must Support | True |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.contact.telecom.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.contact.telecom.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Organization.contact.telecom.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
Organization.contact.address | |
Definition | Visiting or postal addresses for the contact. |
Cardinality | 0...1 |
Type | Address |
Must Support | True |
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Mappings |
|
Organization.contact.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.contact.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.contact.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
Organization.contact.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
Organization.contact.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Organization.contact.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Organization.contact.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Organization.contact.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Organization.contact.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.contact.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Organization.contact.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Organization.contact.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Organization.endpoint | |
Definition | Technical endpoints providing access to services operated for the organization. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HVOOrganizationalUnit" /> <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> <version value="0.1.0" /> <name value="HVOOrganizationalUnit" /> <title value="HVOOrganizationalUnit" /> <status value="draft" /> <description value="HVOOrganizationalUnit contains information about a formally defined entity which constitutes a part of an organization." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Organization" /> <baseDefinition value="http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOrganization" /> <derivation value="constraint" /> <differential> <element id="Organization.contained"> <path value="Organization.contained" /> <slicing> <discriminator> <type value="value" /> <path value="resourceType" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Organization.contained:HVOBusiness"> <path value="Organization.contained" /> <sliceName value="HVOBusiness" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Organization.extension"> <path value="Organization.extension" /> <min value="2" /> </element> <element id="Organization.extension:organizationActive"> <path value="Organization.extension" /> <sliceName value="organizationActive" /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension" /> </type> <mustSupport value="true" /> </element> <element id="Organization.extension:period"> <path value="Organization.extension" /> <sliceName value="period" /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/organization-period" /> </type> <mustSupport value="true" /> </element> <element id="Organization.extension:additionalRelationship"> <path value="Organization.extension" /> <sliceName value="additionalRelationship" /> <min value="0" /> <max value="*" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension" /> </type> <mustSupport value="true" /> </element> <element id="Organization.extension:qualification"> <path value="Organization.extension" /> <sliceName value="qualification" /> <min value="0" /> <max value="*" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Organization.qualification" /> </type> <mustSupport value="true" /> </element> <element id="Organization.identifier"> <path value="Organization.identifier" /> <short value="Identifier for the organizational unit, e.g. the CFAR number from SCB:s Business Register (sv: Företagsregister) or HSA ID from the HSA Catalog Service." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.identifier.system"> <path value="Organization.identifier.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.identifier.value"> <path value="Organization.identifier.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:hsaid"> <path value="Organization.identifier" /> <sliceName value="hsaid" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:hsaid.system"> <path value="Organization.identifier.system" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:hsaid.value"> <path value="Organization.identifier.value" /> <min value="1" /> <constraint> <key value="hvo-organization-hsa-identifier-value-2" /> <severity value="warning" /> <human value="If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE<organization number>-XXX. Characters å, ä, ö, @ not valid." /> <expression value="$this.matches('^SE[0-9]{10}-[A-za-z0-9]+$')" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-organization-hsa-identifier-value-1" /> <severity value="warning" /> <human value="If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters" /> <expression value="$this.length() <= 31" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.identifier:organizationIdentifier"> <path value="Organization.identifier" /> <sliceName value="organizationIdentifier" /> <max value="0" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:organizationIdentifier.system"> <path value="Organization.identifier.system" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:organizationIdentifier.value"> <path value="Organization.identifier.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type"> <path value="Organization.type" /> <slicing> <discriminator> <type value="value" /> <path value="coding.code" /> </discriminator> <description value="Slice on CodeableConcept based on the coding.code" /> <ordered value="false" /> <rules value="open" /> </slicing> <short value="Type of organizational unit. An organizational unit can be categorized in multiple ways depending on the purpose of the categorization." /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-organizational-unit-type" /> </binding> </element> <element id="Organization.type.coding"> <path value="Organization.type.coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type.coding.system"> <path value="Organization.type.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type.coding.version"> <path value="Organization.type.coding.version" /> <mustSupport value="true" /> </element> <element id="Organization.type.coding.code"> <path value="Organization.type.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type:careUnit"> <path value="Organization.type" /> <sliceName value="careUnit" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type:careUnit.coding"> <path value="Organization.type.coding" /> <min value="1" /> <max value="1" /> <patternCoding> <system value="http://snomed.info/sct" /> <version value="http://snomed.info/sct/45991000052106" /> <code value="43741000" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Organization.type:careUnit.coding.system"> <path value="Organization.type.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type:careUnit.coding.version"> <path value="Organization.type.coding.version" /> <mustSupport value="true" /> </element> <element id="Organization.type:careUnit.coding.code"> <path value="Organization.type.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.name"> <path value="Organization.name" /> <short value="The official name of the organizational unit." /> <mustSupport value="true" /> </element> <element id="Organization.alias"> <path value="Organization.alias" /> <short value="A name of the organizational unit that is commonly used and is not the official name, e.g. an abbreviation of the official name." /> <constraint> <key value="hvo-organization-name-1" /> <severity value="warning" /> <human value="Name of Organization should have max length of 200 characters" /> <expression value="$this.length() <= 200" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.telecom"> <path value="Organization.telecom" /> <max value="0" /> <mustSupport value="true" /> </element> <element id="Organization.address"> <path value="Organization.address" /> <max value="0" /> <mustSupport value="true" /> </element> <element id="Organization.partOf"> <path value="Organization.partOf" /> <min value="1" /> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy"> <valueBoolean value="true" /> </extension> <code value="Reference" /> <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" /> </type> <constraint> <key value="hvo-organizational-unit-part-of-1" /> <severity value="warning" /> <human value="An organizational unit must belong to an organization" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.contact"> <path value="Organization.contact" /> <mustSupport value="true" /> </element> <element id="Organization.contact.purpose"> <path value="Organization.contact.purpose" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-contact-purpose" /> </binding> </element> <element id="Organization.contact.name"> <path value="Organization.contact.name" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom"> <path value="Organization.contact.telecom" /> <constraint> <key value="hvo-telecom-phone-1" /> <severity value="warning" /> <human value="If telecom.system = #phone, value should follow format +(1-9)XXXX" /> <expression value="value.matches('^\\+[1-9][0-9]+$') or system != 'phone'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-telecom-phone-1" /> <severity value="warning" /> <human value="If telecom.system = #phone, value should follow format +(1-9)XXXX" /> <expression value="value.matches('^\\+[1-9][0-9]+$') or system != 'phone'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-telecom-phone-2" /> <severity value="warning" /> <human value="If telecom.system = #phone, value should have max length of 32 characters" /> <expression value="value.length() <= 32 or system != 'phone'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-telecom-url-2" /> <severity value="warning" /> <human value="If telecom.system = #url, value should have max length of 2000 characters" /> <expression value="value.length() <= 2000 or system != 'url'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-telecom-email-1" /> <severity value="warning" /> <human value="If telecom.system = #email, value should follow format xxx@xxx.xxx" /> <expression value="value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <constraint> <key value="hvo-telecom-email-2" /> <severity value="warning" /> <human value="If telecom.system = #email, value should have max length of 255 characters" /> <expression value="value.length() <= 255 or system != 'email'" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom.system"> <path value="Organization.contact.telecom.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom.value"> <path value="Organization.contact.telecom.value" /> <min value="1" /> <constraint> <key value="hvo-telecom-value-1" /> <severity value="warning" /> <human value="A telecom value should have max length of 2000 characters" /> <expression value="$this.length() <= 2000" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom.period"> <path value="Organization.contact.telecom.period" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom.period.start"> <path value="Organization.contact.telecom.period.start" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom.period.end"> <path value="Organization.contact.telecom.period.end" /> <mustSupport value="true" /> </element> <element id="Organization.contact.address"> <path value="Organization.contact.address" /> <mustSupport value="true" /> </element> <element id="Organization.contact.address.line"> <path value="Organization.contact.address.line" /> <constraint> <key value="hvo-address-line-1" /> <severity value="warning" /> <human value="An address line should have max length of 128 characters" /> <expression value="$this.length() <= 128" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.contact.address.city"> <path value="Organization.contact.address.city" /> <constraint> <key value="hvo-address-city-1" /> <severity value="warning" /> <human value="An address city should have a max length of 50 characters" /> <expression value="$this.length() <= 50" /> <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" /> </constraint> <mustSupport value="true" /> </element> <element id="Organization.contact.address.postalCode"> <path value="Organization.contact.address.postalCode" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "HVOOrganizationalUnit", "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "version": "0.1.0", "name": "HVOOrganizationalUnit", "title": "HVOOrganizationalUnit", "status": "draft", "description": "HVOOrganizationalUnit contains information about a formally defined entity which constitutes a part of an organization.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Organization", "baseDefinition": "http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOrganization", "derivation": "constraint", "differential": { "element": [ { "id": "Organization.contained", "path": "Organization.contained", "slicing": { "discriminator": [ { "type": "value", "path": "resourceType" } ], "rules": "open" } }, { "id": "Organization.contained:HVOBusiness", "path": "Organization.contained", "sliceName": "HVOBusiness", "min": 0, "max": "1", "mustSupport": true }, { "id": "Organization.extension", "path": "Organization.extension", "min": 2 }, { "id": "Organization.extension:organizationActive", "path": "Organization.extension", "sliceName": "organizationActive", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension" ] } ], "mustSupport": true }, { "id": "Organization.extension:period", "path": "Organization.extension", "sliceName": "period", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/organization-period" ] } ], "mustSupport": true }, { "id": "Organization.extension:additionalRelationship", "path": "Organization.extension", "sliceName": "additionalRelationship", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension" ] } ], "mustSupport": true }, { "id": "Organization.extension:qualification", "path": "Organization.extension", "sliceName": "qualification", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Organization.qualification" ] } ], "mustSupport": true }, { "id": "Organization.identifier", "path": "Organization.identifier", "short": "Identifier for the organizational unit, e.g. the CFAR number from SCB:s Business Register (sv: Företagsregister) or HSA ID from the HSA Catalog Service.", "min": 1, "mustSupport": true }, { "id": "Organization.identifier.system", "path": "Organization.identifier.system", "min": 1, "mustSupport": true }, { "id": "Organization.identifier.value", "path": "Organization.identifier.value", "min": 1, "mustSupport": true }, { "id": "Organization.identifier:hsaid", "path": "Organization.identifier", "sliceName": "hsaid", "mustSupport": true }, { "id": "Organization.identifier:hsaid.system", "path": "Organization.identifier.system", "mustSupport": true }, { "id": "Organization.identifier:hsaid.value", "path": "Organization.identifier.value", "min": 1, "constraint": [ { "key": "hvo-organization-hsa-identifier-value-2", "human": "If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE<organization number>-XXX. Characters å, ä, ö, @ not valid.", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.matches('^SE[0-9]{10}-[A-za-z0-9]+$')" }, { "key": "hvo-organization-hsa-identifier-value-1", "human": "If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.length() <= 31" } ], "mustSupport": true }, { "id": "Organization.identifier:organizationIdentifier", "path": "Organization.identifier", "sliceName": "organizationIdentifier", "max": "0", "mustSupport": true }, { "id": "Organization.identifier:organizationIdentifier.system", "path": "Organization.identifier.system", "mustSupport": true }, { "id": "Organization.identifier:organizationIdentifier.value", "path": "Organization.identifier.value", "min": 1, "mustSupport": true }, { "id": "Organization.type", "path": "Organization.type", "slicing": { "discriminator": [ { "type": "value", "path": "coding.code" } ], "rules": "open", "ordered": false, "description": "Slice on CodeableConcept based on the coding.code" }, "short": "Type of organizational unit. An organizational unit can be categorized in multiple ways depending on the purpose of the categorization.", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-organizational-unit-type" } }, { "id": "Organization.type.coding", "path": "Organization.type.coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "Organization.type.coding.system", "path": "Organization.type.coding.system", "min": 1, "mustSupport": true }, { "id": "Organization.type.coding.version", "path": "Organization.type.coding.version", "mustSupport": true }, { "id": "Organization.type.coding.code", "path": "Organization.type.coding.code", "min": 1, "mustSupport": true }, { "id": "Organization.type:careUnit", "path": "Organization.type", "sliceName": "careUnit", "min": 0, "max": "1", "mustSupport": true }, { "id": "Organization.type:careUnit.coding", "path": "Organization.type.coding", "min": 1, "max": "1", "patternCoding": { "code": "43741000", "system": "http://snomed.info/sct", "version": "http://snomed.info/sct/45991000052106" }, "mustSupport": true }, { "id": "Organization.type:careUnit.coding.system", "path": "Organization.type.coding.system", "min": 1, "mustSupport": true }, { "id": "Organization.type:careUnit.coding.version", "path": "Organization.type.coding.version", "mustSupport": true }, { "id": "Organization.type:careUnit.coding.code", "path": "Organization.type.coding.code", "min": 1, "mustSupport": true }, { "id": "Organization.name", "path": "Organization.name", "short": "The official name of the organizational unit.", "mustSupport": true }, { "id": "Organization.alias", "path": "Organization.alias", "short": "A name of the organizational unit that is commonly used and is not the official name, e.g. an abbreviation of the official name.", "constraint": [ { "key": "hvo-organization-name-1", "human": "Name of Organization should have max length of 200 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.length() <= 200" } ], "mustSupport": true }, { "id": "Organization.telecom", "path": "Organization.telecom", "max": "0", "mustSupport": true }, { "id": "Organization.address", "path": "Organization.address", "max": "0", "mustSupport": true }, { "id": "Organization.partOf", "path": "Organization.partOf", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ] } ], "constraint": [ { "key": "hvo-organizational-unit-part-of-1", "human": "An organizational unit must belong to an organization", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning" } ], "mustSupport": true }, { "id": "Organization.contact", "path": "Organization.contact", "mustSupport": true }, { "id": "Organization.contact.purpose", "path": "Organization.contact.purpose", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-contact-purpose" } }, { "id": "Organization.contact.name", "path": "Organization.contact.name", "mustSupport": true }, { "id": "Organization.contact.telecom", "path": "Organization.contact.telecom", "constraint": [ { "key": "hvo-telecom-phone-1", "human": "If telecom.system = #phone, value should follow format +(1-9)XXXX", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.matches('^\\\\+[1-9][0-9]+$') or system != 'phone'" }, { "key": "hvo-telecom-phone-1", "human": "If telecom.system = #phone, value should follow format +(1-9)XXXX", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.matches('^\\\\+[1-9][0-9]+$') or system != 'phone'" }, { "key": "hvo-telecom-phone-2", "human": "If telecom.system = #phone, value should have max length of 32 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.length() <= 32 or system != 'phone'" }, { "key": "hvo-telecom-url-2", "human": "If telecom.system = #url, value should have max length of 2000 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.length() <= 2000 or system != 'url'" }, { "key": "hvo-telecom-email-1", "human": "If telecom.system = #email, value should follow format xxx@xxx.xxx", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.matches('^[\\\\w.-]{1,64}@(?!.{254})[\\\\w.-]+\\\\.[A-Za-z]{2,4}$') or system != 'email'" }, { "key": "hvo-telecom-email-2", "human": "If telecom.system = #email, value should have max length of 255 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "value.length() <= 255 or system != 'email'" } ], "mustSupport": true }, { "id": "Organization.contact.telecom.system", "path": "Organization.contact.telecom.system", "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom.value", "path": "Organization.contact.telecom.value", "min": 1, "constraint": [ { "key": "hvo-telecom-value-1", "human": "A telecom value should have max length of 2000 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.length() <= 2000" } ], "mustSupport": true }, { "id": "Organization.contact.telecom.period", "path": "Organization.contact.telecom.period", "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom.period.start", "path": "Organization.contact.telecom.period.start", "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom.period.end", "path": "Organization.contact.telecom.period.end", "mustSupport": true }, { "id": "Organization.contact.address", "path": "Organization.contact.address", "mustSupport": true }, { "id": "Organization.contact.address.line", "path": "Organization.contact.address.line", "constraint": [ { "key": "hvo-address-line-1", "human": "An address line should have max length of 128 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.length() <= 128" } ], "mustSupport": true }, { "id": "Organization.contact.address.city", "path": "Organization.contact.address.city", "constraint": [ { "key": "hvo-address-city-1", "human": "An address city should have a max length of 50 characters", "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit", "severity": "warning", "expression": "$this.length() <= 50" } ], "mustSupport": true }, { "id": "Organization.contact.address.postalCode", "path": "Organization.contact.address.postalCode", "mustSupport": true } ] } }
Details
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | yes | Kommentar |
Insert (POST) | yes | Kommentar |
Update (PUT) | yes/no | Kommentar |
Delete (DEL) | no | Kommentar |
Operation (GET, POST) | yes | Kommentar |
Query operations
Supported Queries
.../Organization
returns all Organizations..../Organization/[LogicalId]
returns the Organization with the supplied logical ID..../Organization?[parameters]
and.../Organization/_search?[parameters]
Parameter chains:
identifier=urn:oid:1.2.752.29.4.19|[hsaid]
returns the Organization with the supplied HSA ID.type=[Type]
returns a list of Organizations with the supplied type.name:contains=[Name]&type=[Type]
returns a list of Organizations which names contain the supplied name and have the supplied type._id=[LogicalId1,LogicalId2]
returns a list of Organizations with the provided logical IDs.
Compartment searches
Supported searches on a compartment. This kind of search returns a bundle with the related resources.
Include & reverse includes
Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.
.../Organization?partof=[LogicalId]&type=[Type]&_include=Organization:partof&_revinclude:iterate=Organization:partof
returns the Organization with the supplied Logical ID and Type and a list of Organizations that are a part of that Organization.
Search parameters
Parameter | Description | Comment |
---|---|---|
identifier | External ID of an Organization. | Includes OID for type of external ID. |
_id | Logical ID (UUID) of an Organization. | |
_include | Subject resource to include in the response. | See HL7 Include other resources for more information. |
_revinclude | Related resources of the specified type to include in the response. | See HL7 Include other resources for more information. |
type | Type of Organization. |
Other operations
HVOOrganizationalUnitsWithBusinessById
Operation name | HTTP verbs | Link |
---|---|---|
$hvo-organizational-units-with-business | GET | HVOOrganizationalUnitsWithBusinessById |
Invocations
URL: [base]/Organization/id/$organizational-units-with-business-by-id
This operation does NOT change content
This operation is a namedQuery
Parameters (In)
Name | Cardinality | Type | Documentation |
---|---|---|---|
id | 1..1 | string | Logical ID (UUID) of HVOOrganization or HVOOrganizationalUnit |
name:contains | 0..1 | string | Search string of name of HVOOrganization or HVOOrganizationalUnit, at least 3 characters |
Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
result | 0..1 | Bundle | HVOOrganizationalUnits with at least one business |
Can be invoked using a HTTP GET request.
The operation will search recursively down the organizational hierarchy from the given logical id and return all the HVOOrganizationalUnits which have associated instances of HVOBusiness and match the other search parameters. Example:
.../123/$organizational-units-with-business-by-id?name:contains=abc
HVOOrganizationalUnitsWithBusiness
Operation name | HTTP verbs | Link |
---|---|---|
$hvo-organizational-units-with-business | GET | HVOOrganizationalUnitsWithBusiness |
Invocations
URL: [base]/Organization/$organizational-units-with-business
This operation does NOT change content
This operation is a namedQuery
Parameters (In)
Name | Cardinality | Type | Documentation |
---|---|---|---|
identifier | 1..1 | string | External ID of HVOOrganization or HVOOrganizationalUnit. At the moment only accepting identifier of system urn:oid:2.5.4.97 (organization identifier, sv: organisationsnummer) |
name:contains | 0..1 | string | Search string of name of HVOOrganization or HVOOrganizationalUnit, at least 3 characters |
Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
result | 0..1 | Bundle | HVOOrganizationalUnits with at least one business |
Can be invoked using a HTTP GET request.
The operation will search recursively down the organizational hierarchy from the given parameter(s) and return all the HVOOrganizationalUnits which have associated instances of HVOBusiness and match the other search parameters. Example:
.../$organizational-units-with-business?identifier=urn:oid:2.5.4.97|[organizationIdentifier]&name:contains=abc