Page Status: draft updated 2025-06-16
Ändringslogg
ID | Datum | Kommentar |
---|---|---|
16 | 2025-05-07 | Regel-ID ingår i felmeddelanden |
15 | 2025-04-28 | Lagt till flagga "active" till GetAllRootOrganizations |
14 | 2025-04-24 | hvo-date-1 ändrad till hvo-dateTime-1 som definierar format för tidpunkt (dvs inklusive tid och tidzon). Ta bort hvo-date-2 som sa att tid inte ska anges. |
13 | 2025-04-07 | Ny operation för att hämta rotorganisationer |
12 | 2025-04-02 | Systemid ändrat till 34 i felkoder |
11 | 2025-04-02 | Regel hvo-organization-name-2 som ger varning när användare anger organisationsnamn (kommer från Bolagsverket) |
10 | 2025-03-11 | Endast GET tillåtet för specialoperationer, borde dock vara POST för de med komplexa parametrar |
9 | 2025-03-10 | contact.address.country tillagd (0..1) |
8 | 2025-03-06 | telecom.period borttagen och period extension tillagd på contact nivå. telecom har 1..1 relation till contact |
7 | 2025-02-24 | Felkod och uttryck tillagd per-1 |
6 | 2025-02-24 | hvo-date-1 angår endast format på datum. Ny hvo-date-2 som varnar för att tidpunkt inte sparas. |
5 | 2025-02-19 | contact.purpose har kardinalitet 1..1 |
4 | 2025-02-10 | Värdemängd bunden till contact.purpose (hvo-contact-purpose) uppdaterad med koder från HSA-mappning |
3 | 2025-02-10 | Felkod och uttryck tillagd hvo-date-1 |
2 | 2025-02-03 | Felkoder tillagda för hvo-registered-organization-identifier-1, hvo-personal-identity-number-value-1, hvo-organization-identifier-value-1, hvo-organization-hsa-identifier-value-1, hvo-organization-hsa-identifier-value-2, hvo-organization-name-1, hvo-telecom-phone-1, hvo-telecom-phone-2, hvo-telecom-url-1, hvo-telecom-url-2, hvo-telecom-email-1, hvo-telecom-email-2, hvo-telecom-value-1, hvo-address-line-1, hvo-address-city-1 |
1 | 2025-02-03 | Regel date-1 ändrad till hvo-date-1 för att kunna utesluta tid vid dateTime |
Organization - HVOOrganization
Information domain hvo-organization-business, where this resource is represented as Organisation
Page index
Introduction
The Organization resource as profiled in HVOOrganization contains information about corporations and sole traders.
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 Profiles.
Overview
HVOOrganization (Organization) | C | SEBaseOrganization | |
id | S Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | C | 3..* | Extension |
organizationActive | S C | 1..1 | Extension(boolean) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | |
valueBoolean | boolean | ||
legalForm | S C | 1..1 | Extension(Coding) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
ownershipType | S C | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
period | S C | 1..1 | Extension(Period) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | |
valuePeriod | Period | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
additionalRelationship | S C | 0..* | Extension(Complex) |
id | 0..1 | string | |
extension | C | 2..* | Extension |
additionalRelationship | S C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | |
valueReference | Reference(HVOOrganization) | ||
type | S C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
qualification | S C | 0..* | Extension |
modifierExtension | ?! C | 0..* | Extension |
identifier | S Σ C | 1..* | Identifier |
hsaid | S Σ C | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBindingAuto Value |
system | S Σ | 1..1 | uriAuto Value |
value | S Σ C | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
organizationIdentifier | S Σ C | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBindingAuto Value |
system | S Σ | 1..1 | uriAuto Value |
value | S Σ C | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
personalIdentityNumber | S Σ C | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uriAuto Value |
value | S Σ C | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
active | Σ ?! | 0..1 | boolean |
type | S Σ | 1..* | CodeableConceptBinding |
(All Slices) | |||
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | C | 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 |
careProvider | S Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | CodingAuto Value |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uriAuto Value |
version | S Σ | 0..1 | stringAuto Value |
code | S Σ | 1..1 | codeAuto Value |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | S Σ C | 1..1 | string |
alias | S C | 0..* | string |
telecom | S C | 0..0 | ContactPoint |
address | S C | 0..0 | Address |
partOf | S Σ | 0..1 | Reference(HVOOrganization) |
contact | S | 0..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | 0..* | ContactPoint | |
address | 0..1 | Address | |
addressContact | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 1..* | Extension |
period | S C | 1..1 | Extension(Period) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | |
valuePeriod | Period | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
modifierExtension | Σ ?! C | 0..* | Extension |
purpose | S | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | S | 0..1 | HumanName |
telecom | 0..0 | ContactPoint | |
address | S | 1..1 | Address |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | S Σ C | 0..* | string |
city | S Σ C | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | S Σ | 0..1 | string |
country | S Σ | 0..1 | string |
period | Σ | 0..1 | Period |
telecomContact | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 1..* | Extension |
period | S C | 1..1 | Extension(Period) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriAuto Value |
value[x] | S | 1..1 | |
valuePeriod | Period | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
modifierExtension | Σ ?! C | 0..* | Extension |
purpose | S | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | S | 0..1 | HumanName |
telecom | S C | 1..1 | ContactPoint |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ C | 1..1 | codeBinding |
value | S Σ C | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ | 0..1 | Period |
address | 0..0 | Address | |
endpoint | 0..* | Reference(Endpoint) |
Organization | |||
Short | A grouping of people or organizations with a common purpose | ||
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..* | ||
Constraints |
| ||
Mappings |
| ||
Organization.id | |||
Short | Logical id of this artifact | ||
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 | id | ||
Must Support | True | ||
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 | |||
Short | Metadata about the resource | ||
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 | ||
Constraints |
| ||
Organization.implicitRules | |||
Short | A set of rules under which this content was created | ||
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. | ||
Constraints |
| ||
Organization.language | |||
Short | Language of the resource content | ||
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). | ||
Constraints |
| ||
Organization.text | |||
Short | Text summary of the resource, for human interpretation | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contained | |||
Short | Contained, inline Resources | ||
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. | ||
Mappings |
| ||
Organization.extension | |||
Short | Additional content defined by implementations | ||
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 | 3..* | ||
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) | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:organizationActive | |||
Short | Optional Extensions Element | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:organizationActive.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:organizationActive.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:organizationActive.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension | ||
Mappings |
| ||
Organization.extension:organizationActive.value[x] | |||
Short | The status which the organization is registered with in SCB:s Business Register (sv: Företagsregister), where true implies 'active' and false implies 'inactive'. | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm | |||
Short | Extension for legal form of an organization. | ||
Definition | Extension for legal form of an organization. | ||
Cardinality | 1..1 | ||
Type | Extension(Coding) | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:legalForm.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension | ||
Mappings |
| ||
Organization.extension:legalForm.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Binding | |||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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.extension:legalForm.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].version | |||
Short | Version of the system - if relevant | ||
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 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:legalForm.value[x].userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType | |||
Short | Optional Extensions Element | ||
Definition | Extension for organization ownership type | ||
Cardinality | 0..1 | ||
Type | Extension(Coding) | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:ownershipType.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension | ||
Mappings |
| ||
Organization.extension:ownershipType.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Binding | |||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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.extension:ownershipType.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].version | |||
Short | Version of the system - if relevant | ||
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 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:ownershipType.value[x].userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:period | |||
Short | Extension | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:period.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:period.extension | |||
Short | Extension | ||
Definition | An Extension | ||
Cardinality | 0..0 | ||
Type | Extension | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Organization.extension:period.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://hl7.org/fhir/StructureDefinition/organization-period | ||
Mappings |
| ||
Organization.extension:period.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Period | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:period.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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.extension:period.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:period.value[x].start | |||
Short | Starting time with inclusive boundary | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:period.value[x].end | |||
Short | End time with inclusive boundary, if not ongoing | ||
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. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship | |||
Short | Optional Extensions Element | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:additionalRelationship.extension | |||
Short | Additional content defined by implementations | ||
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 | 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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:additionalRelationship | |||
Short | Additional content defined by implementations | ||
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 | 1..1 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:additionalRelationship.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:additionalRelationship.extension:additionalRelationship.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:additionalRelationship.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | additionalRelationship | ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:additionalRelationship.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Reference(HVOOrganization) | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type | |||
Short | Code for the type of relationship between the organizations. | ||
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 | 1..1 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.id | |||
Short | Unique id for inter-element referencing | ||
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.extension:additionalRelationship.extension:type.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | type | ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Binding | |||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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.extension:additionalRelationship.extension:type.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].version | |||
Short | Version of the system - if relevant | ||
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 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.extension:type.value[x].userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:additionalRelationship.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension | ||
Mappings |
| ||
Organization.extension:additionalRelationship.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 0..0 | ||
Type | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||
Constraints |
| ||
Mappings |
| ||
Organization.extension:qualification | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier | |||
Short | The organization should contain at least an organization number if legal form is corporation or a personal identity number if legal form is sole trader. Can contain additional identifiers used in a national or local context. | ||
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) Slice for swedish organization ID | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:hsaid | |||
Short | Identifies this organization across multiple systems | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:hsaid.id | |||
Short | Unique id for inter-element referencing | ||
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 | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:hsaid.use | |||
Short | usual | official | temp | secondary | old (If known) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:hsaid.type | |||
Short | Description of identifier | ||
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. | ||
Constraints |
| ||
Auto Value | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } ] } | ||
Mappings |
| ||
Organization.identifier:hsaid.system | |||
Short | The namespace for the identifier value | ||
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. | ||
Constraints |
| ||
Auto Value | urn:oid:1.2.752.29.4.19 | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Organization.identifier:hsaid.value | |||
Short | The value that is unique | ||
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. | ||
Constraints |
| ||
Examples | General123456 | ||
Mappings |
| ||
Organization.identifier:hsaid.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:hsaid.assigner | |||
Short | Organization that issued id (may be just text) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:organizationIdentifier | |||
Short | Identifies this organization across multiple systems | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.id | |||
Short | Unique id for inter-element referencing | ||
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 | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.use | |||
Short | usual | official | temp | secondary | old (If known) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.type | |||
Short | Description of identifier | ||
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. | ||
Constraints |
| ||
Auto Value | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] } | ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.system | |||
Short | The namespace for the identifier value | ||
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. | ||
Constraints |
| ||
Auto Value | urn:oid:2.5.4.97 | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.value | |||
Short | The value that is unique | ||
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. | ||
Constraints |
| ||
Examples | General123456 | ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:organizationIdentifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber | |||
Short | Identifies this organization across multiple systems | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.id | |||
Short | Unique id for inter-element referencing | ||
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:personalIdentityNumber.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.use | |||
Short | usual | official | temp | secondary | old (If known) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.type | |||
Short | Description of identifier | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.system | |||
Short | The namespace for the identifier value | ||
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. | ||
Constraints |
| ||
Auto Value | http://electronichealth.se/identifier/personnummer | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.value | |||
Short | The value that is unique | ||
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. | ||
Constraints |
| ||
Examples | General123456 | ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.identifier:personalIdentityNumber.assigner | |||
Short | Organization that issued id (may be just text) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.active | |||
Short | Whether the organization's record is still in active use | ||
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. | ||
Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
Constraints |
| ||
Mappings |
| ||
Organization.type | |||
Short | Kind of organization | ||
Definition | The kind(s) of organization that this is. | ||
Cardinality | 1..* | ||
Type | CodeableConcept | ||
Binding | |||
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(Value) Slice on CodeableConcept based on the coding | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.id | |||
Short | Unique id for inter-element referencing | ||
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 | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding | |||
Short | Code defined by a terminology system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.id | |||
Short | Unique id for inter-element referencing | ||
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 | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.version | |||
Short | Version of the system - if relevant | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider | |||
Short | Kind of organization | ||
Definition | The kind(s) of organization that this is. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | |||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider.id | |||
Short | Unique id for inter-element referencing | ||
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:careProvider.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider.coding | |||
Short | Code defined by a terminology system | ||
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. | ||
Constraints |
| ||
Auto Value | { "system": "http://snomed.info/sct", "version": "http://snomed.info/sct/45991000052106", "code": "143591000052106" } | ||
Mappings |
| ||
Organization.type:careProvider.coding.id | |||
Short | Unique id for inter-element referencing | ||
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:careProvider.coding.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider.coding.system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
Organization.type:careProvider.coding.version | |||
Short | Version of the system - if relevant | ||
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. | ||
Constraints |
| ||
Auto Value | http://snomed.info/sct/45991000052106 | ||
Mappings |
| ||
Organization.type:careProvider.coding.code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Auto Value | 143591000052106 | ||
Mappings |
| ||
Organization.type:careProvider.coding.display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.type:careProvider.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.name | |||
Short | Name of the organization according to Bolagsverket, Skatteverket or SCB. | ||
Definition | A name associated with the organization. | ||
Cardinality | 1..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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.alias | |||
Short | A name of the organization that is commonly used and is not the official name, e.g. an abbreviation of the official name. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.telecom | |||
Short | A contact detail for the organization | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-3 | ||
Constraints |
| ||
Mappings |
| ||
Organization.address | |||
Short | An address for the organization | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: org-2 | ||
Constraints |
| ||
Mappings |
| ||
Organization.partOf | |||
Short | The organization of which this organization forms a part | ||
Definition | The organization of which this organization forms a part. | ||
Cardinality | 0..1 | ||
Type | Reference(HVOOrganization) | ||
Must Support | True | ||
Summary | True | ||
Requirements | Need to be able to track the hierarchy of organizations within an organization. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact | |||
Short | Contact for the organization for a certain purpose | ||
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. | ||
Slicing | Unordered, Open, by telecom(Exists) Slice contact on whether it has a telecom (vs address) | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.id | |||
Short | Unique id for inter-element referencing | ||
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 | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.purpose | |||
Short | The type of contact | ||
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. | ||
Requirements | Need to distinguish between multiple contact persons. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.name | |||
Short | A name associated with the contact | ||
Definition | A name associated with the contact. | ||
Cardinality | 0..1 | ||
Type | HumanName | ||
Requirements | Need to be able to track the person by name. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.telecom | |||
Short | Contact details (telephone, email, etc.) for a contact | ||
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact.address | |||
Short | Visiting or postal addresses for the contact | ||
Definition | Visiting or postal addresses for the contact. | ||
Cardinality | 0..1 | ||
Type | Address | ||
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact | |||
Short | Contact for the organization for a certain purpose | ||
Definition | Contact for the organization for a certain purpose. | ||
Cardinality | 0..1 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.extension | |||
Short | Additional content defined by implementations | ||
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 | 1..* | ||
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) | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period | |||
Short | Optional Extensions Element | ||
Definition | Extension for contact when a BackboneElement to express period of validity. | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.extension:period.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension | ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Period | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.extension:period.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.value[x].start | |||
Short | Starting time with inclusive boundary | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.extension:period.value[x].end | |||
Short | End time with inclusive boundary, if not ongoing | ||
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. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose | |||
Short | The type of contact | ||
Definition | Indicates a purpose for which the contact can be reached. | ||
Cardinality | 1..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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.purpose.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding | |||
Short | Code defined by a terminology system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.purpose.coding.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.version | |||
Short | Version of the system - if relevant | ||
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 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.purpose.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.name | |||
Short | A name associated with the contact | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.telecom | |||
Short | Contact details (telephone, email, etc.) for a contact | ||
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | ||
Cardinality | 0..0 | ||
Type | ContactPoint | ||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.address | |||
Short | Visiting or postal addresses for the contact | ||
Definition | Visiting or postal addresses for the contact. | ||
Cardinality | 1..1 | ||
Type | Address | ||
Must Support | True | ||
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.address.id | |||
Short | Unique id for inter-element referencing | ||
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:addressContact.address.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.address.use | |||
Short | home | work | temp | old | billing - purpose of this address | ||
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. | ||
Constraints |
| ||
Examples | Generalhome | ||
Mappings |
| ||
Organization.contact:addressContact.address.type | |||
Short | postal | physical | both | ||
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). | ||
Constraints |
| ||
Examples | Generalboth | ||
Mappings |
| ||
Organization.contact:addressContact.address.text | |||
Short | Text representation of the address | ||
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. | ||
Constraints |
| ||
Examples | General137 Nowhere Street, Erewhon 9132 | ||
Mappings |
| ||
Organization.contact:addressContact.address.line | |||
Short | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label | ||
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 | ||
Constraints |
| ||
Examples | General137 Nowhere Street | ||
Mappings |
| ||
Organization.contact:addressContact.address.city | |||
Short | Name of city, town etc. | ||
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 | ||
Constraints |
| ||
Examples | GeneralErewhon | ||
Mappings |
| ||
Organization.contact:addressContact.address.district | |||
Short | District name (aka county) | ||
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. | ||
Constraints |
| ||
Examples | GeneralMadison | ||
Mappings |
| ||
Organization.contact:addressContact.address.state | |||
Short | Sub-unit of country (abbreviations ok) | ||
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 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.address.postalCode | |||
Short | Postal code for area | ||
Definition | A postal code designating a region defined by the postal service. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
Alias | Zip | ||
Constraints |
| ||
Examples | General9132 | ||
Mappings |
| ||
Organization.contact:addressContact.address.country | |||
Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
Definition | Country - a nation as commonly understood or generally accepted. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:addressContact.address.period | |||
Short | Time period when address was/is in use | ||
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. | ||
Constraints |
| ||
Examples | General{ "start": "2010-03-23", "end": "2010-07-01" } | ||
Mappings |
| ||
Organization.contact:telecomContact | |||
Short | Contact for the organization for a certain purpose | ||
Definition | Contact for the organization for a certain purpose. | ||
Cardinality | 0..1 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.extension | |||
Short | Additional content defined by implementations | ||
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 | 1..* | ||
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) | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period | |||
Short | Optional Extensions Element | ||
Definition | Extension for contact when a BackboneElement to express period of validity. | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.extension:period.extension | |||
Short | Additional content defined by implementations | ||
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..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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Auto Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOContactPeriodExtension | ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Period | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.value[x].id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.extension:period.value[x].extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.value[x].start | |||
Short | Starting time with inclusive boundary | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.extension:period.value[x].end | |||
Short | End time with inclusive boundary, if not ongoing | ||
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. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose | |||
Short | The type of contact | ||
Definition | Indicates a purpose for which the contact can be reached. | ||
Cardinality | 1..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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.purpose.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding | |||
Short | Code defined by a terminology system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.purpose.coding.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.system | |||
Short | Identity of the terminology 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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.version | |||
Short | Version of the system - if relevant | ||
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 | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.code | |||
Short | Symbol in syntax defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.display | |||
Short | Representation defined by the system | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.purpose.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.name | |||
Short | A name associated with the contact | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom | |||
Short | Contact details (telephone, email, etc.) for a contact | ||
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | ||
Cardinality | 1..1 | ||
Type | ContactPoint | ||
Must Support | True | ||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.id | |||
Short | Unique id for inter-element referencing | ||
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:telecomContact.telecom.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.system | |||
Short | phone | fax | email | pager | url | sms | other | ||
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 | ||
Conditions | The cardinality or value of this element may be affected by these constraints: cpt-2 | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.value | |||
Short | The actual contact point details | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.use | |||
Short | home | work | temp | old | mobile - purpose of this contact point | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.rank | |||
Short | Specify preferred order of use (1 = highest) | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.telecom.period | |||
Short | Time period when the contact point was/is in use | ||
Definition | Time period when the contact point was/is in use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Organization.contact:telecomContact.address | |||
Short | Visiting or postal addresses for the contact | ||
Definition | Visiting or postal addresses for the contact. | ||
Cardinality | 0..0 | ||
Type | Address | ||
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. | ||
Constraints |
| ||
Mappings |
| ||
Organization.endpoint | |||
Short | Technical endpoints providing access to services operated for the organization | ||
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. | ||
Constraints |
| ||
Mappings |
|
Details
Note that certain data of an organization is retrieved from official registries and can not be altered using for example a PUT/POST request. See handbok for where to turn to update this kind of information.
Some of these elements are profiled as mandatory, ie have a cardinality of 1..1, which should be interpreted as a certainty that they will be included in a read. These elements WILL NOT be updated in the backend if provided in a PUT/POST request. The elements to which this applies are listed down below:
- name
- legalForm
- period
Validation rules
This section describes constraints and rules for this resource which POST and PUT request bodies are validated against. A rule consists of an ID, a human readable description and a machine readable expression written in FHIRPath. A rule break can result in either a warning or an error. This result is returned together with an error code and message. See Profiles for more information on resource constraints and Error handling for more information on error handling. Rules that relate directly to the format or content of a specific element can also be found by hovering over that element in the view above, under "Constraints" in the pop up card.
Rule ID | Element | Description | Expression | Error | Severity |
---|---|---|---|---|---|
hvo-dateTime-1 | period.start, period.end, contact.period.start, contact.period.end | DateTime should follow format YYYY-MM-DDThh:mm:ss+zz:zz, e.g. 1905-08-23T13:04:00+01:00 | $this.toString().matches('([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\\\.[0-9]{1,9})?(Z|(\\\\+|-)(0[0-9]|1[0-3]):([0-5][0-9]|14:00)') |
2-34-316: %s är ett ogiltigt format för datum (hvo-dateTime-1) | Error |
per-1 | period, contact.period | If present, start SHALL have a lower value than end | start.hasValue().not() or end.hasValue().not() or (start <= end) |
2-34-318: Startdatumet i en period måste ha ett lägre värde än slutdatumet om båda är angivna (per-1) | Error |
hvo-registered-organization-identifier-1 | identifier.organizationIdentifier | In order to insert an HVOOrganization, the organization identifier (sv: organisationsnummer) must be registered in the Swedish Companies Registration Office (sv: Bolagsverket), unless it is a sole trader. | 2-34-301: Organisationsnumret %s är inte registrerat hos Bolagsverket (hvo-registered-organization-identifier-1) | Error | |
hvo-personal-identity-number-value-1 | identifier.personalIdentityNumber.value | A personal identity number (sv: personnummer) should follow format 19500313-1234 | $this.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-\\d{4}$) |
2-34-302: %s är ett ogiltigt format för personnummer (hvo-personal-identity-number-value-1) | |
hvo-organization-identifier-value-1 | identifier.organizationIdentifier.value | If identifier.system = urn:oid:2.5.4.97, value should follow format for organization identifier (sv: organisationsnummer): 1234567890 | $this.matches('^[0-9]{10}$') |
2-34-303: %s är ett ogiltigt format för organisationsnummer (hvo-organization-identifier-value-1) | Error |
hvo-organization-hsa-identifier-value-1 | identifier.hsaid.value | If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters | $this.length() <= 31 |
2-34-304: %s överskrider maxlängden för HSA ID (hvo-organization-hsa-identifier-value-1) | Error |
hvo-organization-hsa-identifier-value-2 | identifier.hsaid.value | If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE1234567890-ABC1. Characters å, ä, ö, @ not valid. | $this.matches('^SE[0-9]{10}-[A-za-z0-9]+$') |
2-34-305: %s är ett ogiltigt format för HSA ID (hvo-organization-hsa-identifier-value-2) | Error |
hvo-organization-name-1 | name, alias | Name of Organization should have max length of 200 characters | $this.length() <= 200 |
2-34-306: %s överskrider maxlängden för organisationsnamn/alias (hvo-organization-name-1) | Error |
hvo-organization-name-2 | name | Name of Organization can not be altered | $this.hasValue().not() |
2-34-319: Namn på organisation har angetts men kommer inte att lagras (hvo-organization-name-2) | Warning |
hvo-telecom-phone-1 | contact.telecom | If telecom.system = #phone, value should follow format +46123456789 | value.matches('^\\+[1-9][0-9]+$') or system != 'phone' |
2-34-307: %s är ett ogiltigt format för telefonnummer (hvo-telecom-phone-1) | |
hvo-telecom-phone-2 | contact.telecom | If telecom.system = #phone, value should have max length of 32 characters | value.length() <= 32 or system != 'phone' |
2-34-308: %s överskrider maxlängden för telefonnummer (hvo-telecom-phone-2) | |
hvo-telecom-url-1 | contact.telecom | If telecom.system = #url, value should follow valid format. Example: https://example.com | value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url' |
2-34-309: %s är ett ogiltigt format för URL (hvo-telecom-url-1) | |
hvo-telecom-url-2 | contact.telecom | If telecom.system = #url, value should have max length of 2000 characters | value.length() <= 2000 or system != 'url' |
2-34-310: %s överskrider maxlängden för URL (hvo-telecom-url-2) | Error |
hvo-telecom-email-1 | contact.telecom | If telecom.system = #email, value should follow valid format. Example: test@test.com | value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email' |
2-34-311: %s är ett ogiltigt format för e-postadress (hvo-telecom-email-1) | |
hvo-telecom-email-2 | contact.telecom | If telecom.system = #email, value should have max length of 255 characters | value.length() <= 255 or system != 'email' |
2-34-312: %s överskrider maxlängden för e-postadress (hvo-telecom-email-2) | |
hvo-telecom-value-1 | contact.telecom.value | A telecom value should have max length of 2000 characters | $this.length() <= 2000 |
2-34-313: %s överskrider maxlängden för elektronisk adress (hvo-telecom-value-1) | Error |
hvo-address-line-1 | contact.address.line | A line in an address should have max length of 128 characters | $this.length() <= 128 |
2-34-314: %s överskrider maxlängden för adressrad (hvo-address-line-1) | Error |
hvo-address-city-1 | contact.address.city | A city in an address should have a max length of 50 characters | $this.length() <= 50 |
2-34-315: %s överskrider maxlängden för postort (hvo-address-city-1) | Error |
Supported operations
HTTP methods
Operation | Supported | Invocation | Comment |
---|---|---|---|
Search (GET, POST) | yes | See section Query operations | |
Insert (POST) | yes | POST .../Organization |
See Examples of request bodies for different use cases. Use HVOOrganizationTransactionBundle to send multiple organizations to insert/update. |
Update (PUT) | yes/no | Use HVOOrganizationTransactionBundle to send multiple organizations to insert/update. | |
Delete (DEL) | no | ||
Operation (GET, POST) | yes | See section Other operations |
Query operations
Supported Queries
GET .../Organization
returns a Bundle of all Organizations.GET .../Organization/[LogicalId]
returns the Organization with the supplied logical ID.GET .../Organization/[LogicalId]/_history/[VersionId]
returns the version of the Organization with the supplied logical ID and version ID.GET .../Organization?[parameters]
Parameter options:
identifier=[system]|[identifier]
returns the Organization with the supplied identifier._id=[LogicalId1]{,LogicalId2}
returns a Bundle of Organizations with the provided logical IDs.type=[system]|[code]
returns a Bundle of Organizations with the supplied type.name:contains=[Name]
returns a Bundle of Organizations which names contain the supplied name.partof=[LogicalId]
returns a Bundle of Organizations which are a part of the Organization with the supplied logical ID.
Search parameters
Parameter | Description | Comment |
---|---|---|
_id | Logical ID (UUID) of an Organization. | |
identifier | External ID of an Organization. | Includes OID for type of external ID. |
name:contains | At least three letters of the name of an Organization. | |
Organization/[LogicalId] | A read based on the logical ID (UUID) of an Organization. | |
Organization/[LogicalId]/_history/[VersionId] | A vread to get the specific version of an Organization. | |
partof | Logical ID of the Organization which this Organization is a part of. | |
type | Type of Organization. | Includes codesystem and code. |
Other operations
GetAllRootOrganizations
Gets all HVOOrganizations that are root organizations, ie legal entities and sole traders.
Operation name | HTTP verbs | Link |
---|---|---|
$root-organizations | GET | GetAllRootOrganizations↗ |
Parameters (In)
Name | Cardinality | Type | Documentation |
---|---|---|---|
active | 0..1 | boolean | Boolean indicating whether to filter on active or on inactive root organizations. Both active and inactive root organizations will be returned if the parameter is omitted |
Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
return | 0..1 | Bundle | A Bundle with HVOOrganizations that are root organizations |
Invocations
URL: [base]/Organization/$root-organizations
Example:
.../$root-organizations?active=true
This operation does NOT change content
GetHVOOrganizationalUnitsWithBusinessById
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.
Operation name | HTTP verbs | Link |
---|---|---|
$organizational-units-with-business | GET | GetHVOOrganizationalUnitsWithBusinessById↗ |
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 HVOOrganizationalUnit, at least 3 characters |
Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
return | 0..1 | Bundle | HVOOrganizationalUnits with at least one business |
Invocations
URL: [base]/Organization/[id]/$organizational-units-with-business-by-id
Example:
.../123/$organizational-units-with-business-by-id?name:contains=abc
This operation does NOT change content
GetHVOOrganizationalUnitsWithBusiness
The operation will search recursively down the organizational hierarchy from the given identifier and return all the HVOOrganizationalUnits which have associated instances of HVOBusiness and match the other search parameters.
Operation name | HTTP verbs | Link |
---|---|---|
$organizational-units-with-business | GET | GetHVOOrganizationalUnitsWithBusiness↗ |
Parameters (In)
Name | Cardinality | Type | Documentation |
---|---|---|---|
identifier | 1..1 | string | External ID of HVOOrganization or HVOOrganizationalUnit in the format "system|value". 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 HVOOrganizationalUnit, at least 3 characters |
Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
return | 0..1 | Bundle | HVOOrganizationalUnits with at least one business |
Invocations
URL: [base]/Organization/$organizational-units-with-business
The following example shows an invocation when searching for the HVOOrganizationalUnits of a HVOOrganization with the organization number 5565932521 (OID urn:oid:2.5.4.97) and filtering the units by the ones with the name containing "vårdcentral".
.../$organizational-units-with-business?identifier=urn:oid:2.5.4.97|5565932521&name:contains=vårdcentral
This operation does NOT change content