Page Status: draft updated 2025-10-22
Ändringslogg
| ID | Datum | Kommentar |
|---|---|---|
| 14 | 2025-10-22 | Lagt till regel för felaktig kardinalitet, kod, identitetssystem. Förtydligat att orgnr ej är giltigt för enhet |
| 13 | 2025-10-17 | Lagt till regel för att inte ange tidsstämpel i dateTime |
| 12 | 2025-10-17 | Generisk regel för ogiltig kod ersätter regel för giltiga värden på contact.telecom.system |
| 11 | 2025-10-13 | Lagt till regel för giltiga värden på contact.telecom.system |
| 10 | 2025-10-10 | Lagt till fax i samma regel som telefonnr gällande maxlängd och format |
| 9 | 2025-10-10 | Brytit ut egen regel för alias gällande maxlängd |
| 8 | 2025-10-06 | Lagt till valideringsregel på parameter name:contains i GET samt operationer |
| 7 | 2025-10-06 | Lagt till exempel på alla operationer |
| 6 | 2025-09-10 | Förtydligat att parameter name:contains i GetFilteredOrganizations ignoreras om söksträngen är tom |
| 5 | 2025-09-10 | Default för parameter _count i GetFilteredOrganizations är 100 |
| 4 | 2025-08-25 | Sökparameter type kan vara lista |
| 3 | 2025-08-21 | Förtydligat att även alias söks på varje gång namn söks på |
| 2 | 2025-07-14 | Tagit bort de operations som ersätts av GetFilteredHVOOrganizationalUnits |
| 1 | 2025-06-18 | Lagt till operation GetFilteredHVOOrganizationalUnits |
Organization - HVOOrganizationalUnit
Information domain hvo-organization-business, where this resource is represented as OrganisatoriskEnhet
Page index
General information
The Organization resource as profiled in HVOOrganizationalUnit contains information about a formally defined entity which constitutes a part of an organization.
Profile
| HVOOrganizationalUnit (Organization) | C | Organization | |
| id | S Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| HVOBusiness | S C | 0..1 | HVOBusiness |
| extension | C | 2..* | Extension |
| organizationActive | S C | 1..1 | Extension(boolean) |
| id | 0..1 | id | |
| extension | C | 0..0 | Extension |
| url | S | 1..1 | uriFixed Value |
| value[x] | S C | 1..1 | |
| valueBoolean | boolean | ||
| period | S C | 1..1 | Extension(Period) |
| id | 0..1 | id | |
| extension | C | 0..0 | Extension |
| url | S | 1..1 | uriFixed Value |
| value[x] | S C | 1..1 | |
| valuePeriod | Period | ||
| id | 0..1 | id | |
| 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 | id | |
| extension | C | 2..* | Extension |
| additionalRelationship | S C | 1..1 | Extension |
| id | 0..1 | id | |
| extension | C | 0..0 | Extension |
| url | S | 1..1 | uriFixed Value |
| value[x] | S C | 1..1 | |
| valueReference | Reference(HVOOrganizationalUnit) | ||
| type | S C | 1..1 | Extension |
| id | 0..1 | id | |
| extension | C | 0..0 | Extension |
| url | S | 1..1 | uriFixed Value |
| value[x] | S C | 1..1 | Binding |
| valueCoding | Coding | ||
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| url | 1..1 | uriFixed Value | |
| value[x] | C | 0..0 | |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | S Σ C | 1..* | Identifier |
| (All Slices) | |||
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| hsaid | Σ C | 0..* | Identifier |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriPattern |
| value | S Σ C | 1..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| type | S Σ | 0..* | CodeableConceptBinding |
| (All Slices) | |||
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | S Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| careUnit | S Σ | 0..1 | CodeableConceptBinding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | CodingFixed Value |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | S Σ | 0..1 | stringFixed Value |
| code | S Σ C | 1..1 | codeFixed Value |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| name | S Σ C | 0..1 | string |
| alias | S C | 0..* | string |
| description | Σ | 0..1 | markdown |
| contact | S C | 0..* | ExtendedContactDetail |
| addressContact | S C | 0..* | ExtendedContactDetail |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| purpose | S Σ | 1..1 | CodeableConceptBinding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 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 | id | |
| 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 |
| organization | Σ | 0..1 | Reference(Organization) |
| period | S Σ | 1..1 | Period |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| telecomContact | S C | 0..* | ExtendedContactDetail |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| purpose | S Σ | 1..1 | CodeableConceptBinding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 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 | id | |
| 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 |
| organization | Σ | 0..1 | Reference(Organization) |
| period | S Σ | 1..1 | Period |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| partOf | S Σ | 0..1 | Reference(HVOOrganizationalUnit | HVOOrganization) |
| endpoint | 0..* | Reference(Endpoint) | |
| qualification | S | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | S | 1..1 | Identifier |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| code | S | 1..1 | CodeableConcept |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| period | S | 1..1 | Period |
| id | 0..1 | id | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| issuer | 0..1 | Reference(Organization) |
| 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 | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 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 its 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 | IETF language tag for 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 a 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Slicing | Unordered, Open, by contained(Profile) |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| Organization.contained:HVOBusiness | |
| Short | Business which the organizational unit conducts |
| Definition | The details of a healthcare service available at a location. |
| Cardinality | 0..1 |
| Type | HVOBusiness |
| Must Support | True |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Constraints |
|
| 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 managable, 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) |
| 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. |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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. |
| Fixed 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 |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| 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. |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/organization-period |
| Mappings |
|
| Organization.extension:period.value[x] | |
| Short | The period during which the organization is/was registered with the given status in SCB:s Business Register (sv: Företagsregister). |
| 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 |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 end 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 organizational units, for example that an organization owns or is owned by another organizational unit. |
| 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. |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 managable, 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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. |
| Fixed 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(HVOOrganizationalUnit) |
| Must Support | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| Constraints |
|
| Mappings |
|
| Organization.extension:additionalRelationship.extension:type | |
| 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 managable, 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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. |
| Fixed 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 | hvo-organizational-unit-additional-relationship-type (required) |
| Must Support | True |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 be an absolute 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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. |
| Fixed Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnitAdditionalRelationshipExtension |
| 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| 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 managable, 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 |
| Summary | 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 | Identifier for the organizational unit, e.g. HSA ID from the HSA Catalog Service. |
| 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 identifier to express different kinds of identifiers |
| Conditions | The cardinality or value of this element may be affected by these constraints: org-1 |
| Constraints |
|
| Mappings |
|
| Organization.identifier.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.identifier.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 managable, 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.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.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.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute 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 |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Organization.identifier.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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Organization.identifier.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.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: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..* |
| Type | Identifier |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 |
|
| Mappings |
|
| Organization.identifier:hsaid.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute 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 |
|
| Pattern | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| 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.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 | Type of organizational unit. An organizational unit can be categorized in multiple ways depending on the purpose of the categorization. |
| Definition | The kind(s) of organization that this is. |
| Cardinality | 0..* |
| Type | CodeableConcept |
| Binding | Used to categorize the organization. |
| Must Support | True |
| Summary | True |
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
| Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
| Slicing | Unordered, Open, by coding(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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 be an absolute 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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:careUnit | |
| Short | Kind of organization |
| Definition | The kind(s) of organization that this is. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | Used to categorize the organization. |
| Must Support | True |
| Summary | True |
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
| Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
| Constraints |
|
| Mappings |
|
| Organization.type:careUnit.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.type:careUnit.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 managable, 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:careUnit.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 |
|
| Fixed Value | {
"system": "http://snomed.info/sct",
"version": "http://snomed.info/sct/45991000052106",
"code": "43741000"
} |
| Mappings |
|
| Organization.type:careUnit.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.type:careUnit.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 managable, 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:careUnit.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 be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | http://snomed.info/sct |
| Mappings |
|
| Organization.type:careUnit.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 |
|
| Fixed Value | http://snomed.info/sct/45991000052106 |
| Mappings |
|
| Organization.type:careUnit.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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Fixed Value | 43741000 |
| Mappings |
|
| Organization.type:careUnit.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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Organization.type:careUnit.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:careUnit.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 | The official name of the organizational unit. |
| Definition | A name associated with the organization. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Requirements | Need to use the name as the label of the organization. |
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
| 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 organizational unit 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.description | |
| Short | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name |
| Definition | Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected. |
| Cardinality | 0..1 |
| Type | markdown |
| Summary | True |
| Requirements | Humans need additional information to verify a correct Organization has been selected. |
| Constraints |
|
| Mappings |
|
| Organization.contact | |
| Short | Official contact details for the Organization |
| Definition | The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
| Cardinality | 0..* |
| Type | ExtendedContactDetail |
| Must Support | True |
| Requirements | Need to keep track of assigned contact points within bigger organization. |
| Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. |
| Slicing | Unordered, Open, by telecom(Exists) Slice contact on whether it has a telecom (vs address) |
| Constraints |
|
| Mappings |
|
| Organization.contact:addressContact | |
| Short | Official contact details for the Organization |
| Definition | The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
| Cardinality | 0..* |
| Type | ExtendedContactDetail |
| Must Support | True |
| Requirements | Need to keep track of assigned contact points within bigger organization. |
| Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 | |
| Short | The type of contact |
| Definition | The purpose/type of contact. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | The purpose for which an extended contact detail should be used. |
| Must Support | True |
| Summary | True |
| Comments | If no purpose is defined, then these contact details may be used for any purpose. |
| Constraints |
|
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 be an absolute 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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 | Name of an individual to contact |
| Definition | The name of an individual to contact, some types of contact detail are usually blank. |
| Cardinality | 0..1 |
| Type | HumanName |
| Must Support | True |
| Summary | True |
| Comments | If there is no named individual, the telecom/address information is not generally monitored by a specific individual. |
| Constraints |
|
| Organization.contact:addressContact.telecom | |
| Short | Contact details (e.g.phone/fax/url) |
| Definition | The contact details application for the purpose defined. |
| Cardinality | 0..0 |
| Type | ContactPoint |
| Summary | True |
| Constraints |
|
| Organization.contact:addressContact.address | |
| Short | Address for the contact |
| Definition | Address for the contact. |
| Cardinality | 1..1 |
| Type | Address |
| Must Support | True |
| Summary | True |
| Comments | More than 1 address would be for different purposes, and thus should be entered as a different entry,. |
| Constraints |
|
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 (home / work / etc.). |
| 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. may 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 2- or 3- letter codes MAY 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:addressContact.organization | |
| Short | This contact detail is handled/monitored by a specific organization |
| Definition | This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm). |
| Constraints |
|
| Organization.contact:addressContact.period | |
| Short | Period that this contact was valid for usage |
| Definition | Period that this contact was valid for usage. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Summary | True |
| Comments | If the details have multiple periods, then enter in a new ExtendedContact with the new period. |
| Constraints |
|
| Organization.contact:addressContact.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.contact:addressContact.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 managable, 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.period.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.period.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 end 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 | |
| Short | Official contact details for the Organization |
| Definition | The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
| Cardinality | 0..* |
| Type | ExtendedContactDetail |
| Must Support | True |
| Requirements | Need to keep track of assigned contact points within bigger organization. |
| Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. |
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 | |
| Short | The type of contact |
| Definition | The purpose/type of contact. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | The purpose for which an extended contact detail should be used. |
| Must Support | True |
| Summary | True |
| Comments | If no purpose is defined, then these contact details may be used for any purpose. |
| Constraints |
|
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 be an absolute 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| 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 | Name of an individual to contact |
| Definition | The name of an individual to contact, some types of contact detail are usually blank. |
| Cardinality | 0..1 |
| Type | HumanName |
| Must Support | True |
| Summary | True |
| Comments | If there is no named individual, the telecom/address information is not generally monitored by a specific individual. |
| Constraints |
|
| Organization.contact:telecomContact.telecom | |
| Short | Contact details (e.g.phone/fax/url) |
| Definition | The contact details application for the purpose defined. |
| Cardinality | 1..1 |
| Type | ContactPoint |
| Must Support | True |
| Summary | True |
| Constraints |
|
| 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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cpt-2 |
| 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. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts. |
| 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 | Address for the contact |
| Definition | Address for the contact. |
| Cardinality | 0..0 |
| Type | Address |
| Summary | True |
| Comments | More than 1 address would be for different purposes, and thus should be entered as a different entry,. |
| Constraints |
|
| Organization.contact:telecomContact.organization | |
| Short | This contact detail is handled/monitored by a specific organization |
| Definition | This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm). |
| Constraints |
|
| Organization.contact:telecomContact.period | |
| Short | Period that this contact was valid for usage |
| Definition | Period that this contact was valid for usage. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Summary | True |
| Comments | If the details have multiple periods, then enter in a new ExtendedContact with the new period. |
| Constraints |
|
| Organization.contact:telecomContact.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.contact:telecomContact.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 managable, 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.period.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.period.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 end 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.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(HVOOrganizationalUnit | HVOOrganization) |
| Must Support | True |
| Summary | True |
| Requirements | Need to be able to track the hierarchy of organizations within an organization. |
| 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 |
|
| Organization.qualification | |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Definition | The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Must Support | True |
| Constraints |
|
| Mappings |
|
| Organization.qualification.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 |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.qualification.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 managable, 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.qualification.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 managable, 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.qualification.identifier | |
| Short | An identifier for this qualification for the organization |
| Definition | An identifier allocated to this qualification for this organization. |
| Cardinality | 1..1 |
| Type | Identifier |
| Must Support | True |
| Requirements | Often, specific identities are assigned for the qualification by the assigning organization. |
| Constraints |
|
| Mappings |
|
| Organization.qualification.identifier.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.qualification.identifier.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 managable, 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.qualification.identifier.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.qualification.identifier.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.qualification.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute 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 |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Organization.qualification.identifier.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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Organization.qualification.identifier.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.qualification.identifier.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.qualification.code | |
| Short | Coded representation of the qualification |
| Definition | Coded representation of the qualification. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | Specific qualification the organization has to provide a service. |
| Must Support | True |
| Constraints |
|
| Mappings |
|
| Organization.qualification.code.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.qualification.code.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 managable, 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.qualification.code.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.qualification.code.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.qualification.code.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 managable, 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.qualification.code.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 be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| Organization.qualification.code.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.qualification.code.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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Organization.qualification.code.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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Organization.qualification.code.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.qualification.code.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.qualification.period | |
| Short | Period during which the qualification is valid |
| Definition | Period during which the qualification is valid. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Requirements | Qualifications are often for a limited period of time, and can be revoked. |
| Constraints |
|
| Mappings |
|
| Organization.qualification.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 | id |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Organization.qualification.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 managable, 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.qualification.period.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.qualification.period.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 end 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.qualification.issuer | |
| Short | Organization that regulates and issues the qualification |
| Definition | Organization that regulates and issues the qualification. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Constraints |
|
| Mappings |
|
| HVOOrganisationLogical | Base | ||
| id | C | 1..* | Identifier |
| typ | C | 1..* | Coding |
| status | 1..1 | boolean | |
| namn | 1..1 | string | |
| alias | 0..* | string | |
| juridiskForm | C | 1..1 | Coding |
| agarkategori | C | 0..1 | Coding |
| giltigFrom | 1..1 | time | |
| giltigTom | 0..1 | time | |
| relationOrganisation2 | C | 0..* | Reference(HVOOrganisationLogical) |
| har | C | 0..* | Reference(HVOKontaktuppgiftLogical) |
| har2 | C | 0..* | Reference(HVOTillstandLogical) |
| relationOrganisation | C | 0..* | Reference(HVOOrganisationLogical) |
Details
The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.
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 Constraints and Error handling for more information. 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 | Error | Severity | Expression |
|---|---|---|---|---|---|
| hvo-cardinality-1 | Cardinality of elements must be followed | 2-34-321: Attribut %s har kardinalitet %s men har angivits %s gånger (hvo-cardinality-1) | Error | ||
| hvo-address-city-1 | contact.address.city | A city in an address should have a max length of 50 characters | 2-34-315: %s överskrider maxlängden för postort (hvo-address-city-1) | Error | $this.length() <= 50 |
| hvo-address-line-1 | contact.address.line | A line in an address should have max length of 128 characters | 2-34-314: %s överskrider maxlängden för adressrad (hvo-address-line-1) | Error | $this.length() <= 128 |
| 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 | 2-34-316: %s är ett ogiltigt format för datum (hvo-dateTime-1) | Error | |
| hvo-dateTime-2 | period.start, period.end, contact.period.start, contact.period.end | DateTime should be submitted without timestamp | 2-34-317: %s måste anges utan tidsstämpel (hvo-dateTime-2) | Error | $this.toString().contains('T') = false |
| hvo-identifier-system-1 | identifier.system | Organization identifier (sv: organisationsnummer) can not be used for organizational unit | 2-34-331: Organisationsnummer får ej anges för organisatorisk enhet (hvo-identifier-system-1) | Error | |
| hvo-identifier-system-1 | identifier.system | Identifier.system must be valid system according to profile | 2-34-332: %s är ett ogiltigt system för identifierare (hvo-identifier-system-1) | Error | |
| hvo-organization-alias-1 | alias | Alias of Organization should have max length of 200 characters | 2-34-327: %s överskrider maxlängden för organisations alias (hvo-organization-alias-1) | Error | $this.length() <= 200 |
| 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 | 2-34-304: %s överskrider maxlängden för HSA ID (hvo-organization-hsa-identifier-value-1) | Error | $this.length() <= 31 |
| 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. | 2-34-305: %s är ett ogiltigt format för HSA ID (hvo-organization-hsa-identifier-value-2) | Error | $this.matches('^SE[0-9]{10}-[A-za-z0-9]+$') |
| hvo-organization-name-1 | name | Name of Organization should have max length of 200 characters | 2-34-306: %s överskrider maxlängden för organisationsnamn (hvo-organization-name-1) | Error | $this.length() <= 200 |
| hvo-active-root-organization-1 | Root organization of organizational unit must be active | 2-34-333: | Error | ||
| hvo-required-code-1 | Code must be from required value set | 2-34-329: Ogiltig kod har angivits för %s (hvo-required-code) | Error | ||
| hvo-telecom-email-1 | contact.telecom | If telecom.system = #email, value should follow valid format. Example: test@test.com | 2-34-311: %s är ett ogiltigt format för e-postadress (hvo-telecom-email-1) | Error | value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email' |
| hvo-telecom-email-2 | contact.telecom | If telecom.system = #email, value should have max length of 255 characters | 2-34-312: %s överskrider maxlängden för e-postadress (hvo-telecom-email-2) | Error | value.length() <= 255 or system != 'email' |
| hvo-telecom-phone-1 | contact.telecom | If telecom.system = phone or fax, value should follow format +46123456789 | 2-34-307: %s är ett ogiltigt format för telefonnummer (hvo-telecom-phone-1) | Error | value.matches('^\\+[1-9][0-9]+$') or system != (system != 'phone' and system != 'fax') |
| hvo-telecom-phone-2 | contact.telecom | If telecom.system = phone or fax, value should have max length of 32 characters | 2-34-308: %s överskrider maxlängden för telefonnummer (hvo-telecom-phone-2) | Error | value.length() <= 32 or (system != 'phone' and system != 'fax') |
| hvo-telecom-url-1 | contact.telecom | If telecom.system = #url, value should follow valid format. Example: https://example.com | 2-34-309: %s är ett ogiltigt format för URL (hvo-telecom-url-1) | Error | value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url' |
| hvo-telecom-url-2 | contact.telecom | If telecom.system = #url, value should have max length of 2000 characters | 2-34-310: %s överskrider maxlängden för URL (hvo-telecom-url-2) | Error | value.length() <= 2000 or system != 'url' |
| hvo-telecom-value-1 | contact.telecom.value | A telecom value should have max length of 2000 characters | 2-34-313: %s överskrider maxlängden för elektronisk adress (hvo-telecom-value-1) | Error | $this.length() <= 2000 |
| per-1 | period, contact.period | If present, start SHALL have a lower value than 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 | start.hasValue().not() or end.hasValue().not() or (start <= end) |
Supported operations
HTTP methods
| Operation | Supported | Invocation | Comment |
|---|---|---|---|
| Search (GET, POST) | yes | See section Query operations | |
| Insert (POST) | yes | POST .../Organization |
See Examples for examples of request bodies. Use HVOOrganizationTransactionBundle to send multiple organizations to insert/update. |
| Update (PUT) | yes/no | Use HVOOrganizationTransactionBundle to send multiple organizational units to insert/update. | |
| Delete (DEL) | no | ||
| Operation (GET, POST) | yes | See section Other operations |
Query operations
Supported Queries
GET .../Organizationreturns 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]{,[system]|[code]}returns a Bundle of Organizations with the supplied type(s).name:contains=[Name]returns a Bundle of Organizations which names or aliases contain the supplied name. The search string must be at least 3 characters.partof=[LogicalId]returns a Bundle of Organizations which are a part of the Organization with the supplied logical ID.
Include & reverse includes
Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.
GET .../Organization?partof=[LogicalId]&type=[Type]&[includes]
Include/reverse include options that can be chained using "&":
_include=Organization:partof_revinclude:iterate=Organization:partof
Search parameters
| Parameter | Description | Comment |
|---|---|---|
| _id | Logical ID (UUID) of an Organization. | |
| _include | Subject resource to include in the response. | See HL7 Include other resources for more information. |
| _revinclude | Related resources of the specified type to include in the response. | See HL7 Include other resources for more information. |
| identifier | External ID of an Organization. | Includes system ID for type of external identifier. See use case Search for organization by business identifier for more information and examples. |
| name:contains | At least three letters of the name of an Organization. | Note that also aliases (Organization.alias) will be searched through using this parameter. |
| 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. |
Validation rules
| Rule ID | Parameter | Description | Error message | Severity |
|---|---|---|---|---|
| hvo-search-organization-name-1 | name:contains | Search string of name or alias must be at least 3 characters | 2-34-322: Sökning på namn behöver innehålla minst tre tecken (hvo-search-organization-name-1) | Error |
Other operations
GetFilteredHVOOrganizationalUnits
Gets all HVOOrganizationalUnits that conduct a HVOBusiness and match the supplied parameters.
This operation does NOT change content.
This operation is paginated. See Paging for more information.
| Operation name | HTTP verbs |
|---|---|
| $organizational-units-filtered | GET |
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| business-category | 0..* | string | Category code of HVOBusiness which the HVOOrganizationalUnit provides, in the format "codesystem|code" |
| name:contains | 0..1 | string | Search string of name or alias of HVOOrganizationalUnit, at least 3 characters. An empty search string will be ignored |
| locationId | 0..* | string | Logical ID (UUID) of HVOLocation on which the HVOOrganizationalUnit provides a HVOBusiness |
| _count | 0..1 | integer | (Used for paging) Number of HVOOrganizationalUnits that should be included in the returned Bundle. The default number is 100 |
| _offset | 0..1 | integer | (Used for paging) Number of HVOOrganizationalUnits that the server should skip before retrieving the number of HVOOrganizationalUnits according to the _count parameter. The HVOOrganizationalUnits are sorted by HVOOrganizationalUnit.name in alphabetical order. The default number is 0 |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 0..1 | Bundle | A Bundle with HVOOrganizationalUnits that conduct business and which match the supplied parameters, sorted by HVOOrganizationalUnit.name in alphabetical order |
Invocations
URL: [base]/Organization/$organizational-units-filtered
Validation Rules
| Rule ID | Parameter | Description | Error message | Severity |
|---|---|---|---|---|
| hvo-search-organization-name-1 | name:contains | Search string of name or alias must be at least 3 characters | 2-34-322: Sökning på namn behöver innehålla minst tre tecken (hvo-search-organization-name-1) | Error |
Note that all example data is fictional and not actual data that can be queried.
Search for organizational units with neurology business
Invocation
Example of searching for HVOOrganizationalUnits that contain a business in the field neurologic care or neurologic care for children. The invocation example uses HSA business classification codes (OID urn:oid:1.2.752.129.2.2.1.3) - 1123 ("Neurologi") and 1019 ("Neurologi, barn och ungdom"). The result shows an organizational unit that contain a business in the neurologic care field.
[base]/Organization/$organizational-units-filtered?business-category=urn:oid:1.2.752.129.2.2.1.3|1123, urn:oid:1.2.752.129.2.2.1.3|1019
Result
The example result is a Bundle with one entry - a HVOOrganizationalUnit that contains a HVOBusiness whose category codes contain the code 1123 from system urn:oid:1.2.752.129.2.2.1.3, which is one of the codes that have been searched for.
SearchResultOrganizationalUnitsByBusinessCategory
Examples in the Bundle:
- Bundle.entry: Akut- stroke och neurologiavdelningen - HVOOrganizationalUnit that matches the search
- Organization.contained: NeurologyAndInternalMedicineBusiness - HVOBusiness that the organizational unit runs
- Organization.contained.location: Västerås - HVOLocation where the unit's business is provided
GetHVOOrganizationalUnitsWithBusiness
Gets the HVOOrganizationalUnits of a HVOOrganization that have a HVOBusiness.
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.
This operation does NOT change content
| Operation name | HTTP verbs |
|---|---|
| $organizational-units-with-business | GET |
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| identifier | 1..1 | string | External ID of HVOOrganization whose units to search through, 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 or alias of HVOOrganizationalUnit, at least 3 characters |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 0..1 | Bundle | HVOOrganizationalUnits that are a part of the supplied organization and that have a contained HVOBusiness |
Invocations
URL: [base]/Organization/$organizational-units-with-business
Validation Rules
| Rule ID | Parameter | Description | Error message | Severity |
|---|---|---|---|---|
| hvo-search-organization-name-1 | name:contains | Search string of name or alias must be at least 3 characters | 2-34-322: Sökning på namn behöver innehålla minst tre tecken (hvo-search-organization-name-1) | Error |
Note that all example data is fictional and not actual data that can be queried.
Search for organizational units that run business and is part of specific healthcare provider
Invocation
Example of searching for HVOOrganizationalUnits whose names contain "naprapat" and that are a part of an HVOOrganization with the organization identifier 1234567890 (the system ID for organization identifier is urn:oid:2.5.4.97).
[base]/Organization/$organizational-units-with-business?identifier=urn:oid:2.5.4.97|1234567890&name:contains=naprapat
Result
Example of result from searching for HVOOrganizationalUnits whose names contain "naprapat" and that are a part of an HVOOrganization with the organization identifier 1234567890. The result is a Bundle with one HVOOrganizationalUnit.
Bundle: SearchResultOrganizationalUnitsWithBusiness
Examples in the Bundle:
- Bundle.entry: Naprapathälsa - HVOOrganizationalUnit that matches the search
- Organization.contained: BusinessInNaprapathy - HVOBusiness that the organizational unit runs
- Organization.contained.location: Västerås naprapatklinik - HVOLocation where the unit's business is provided
- Organization.partOf: Naprapathälsa HVOOrganization that the unit is a part of, as searched for
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.
This operation does NOT change content
| Operation name | HTTP verbs |
|---|---|
| $organizational-units-with-business | GET |
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 or alias 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
Validation Rules
| Rule ID | Parameter | Description | Error message | Severity |
|---|---|---|---|---|
| hvo-search-organization-name-1 | name:contains | Search string of name or alias must be at least 3 characters | 2-34-322: Sökning på namn behöver innehålla minst tre tecken (hvo-search-organization-name-1) | Error |
Note that all example data is fictional and not actual data that can be queried.
Search for organizational units with name "parodontolog" that are part of specific healthcare unit
Invocation
The following example shows how to search for all HVOOrganizationalUnits (that run a HVOBusiness) that are a part of the organization with the logical ID 123-456-678 and whose names contain "parodontolog".
[base]/Organization/123-456-678/$organizational-units-with-business-by-id?name:contains=parodontolog
Result
The result is a Bundle with one entry, that is a part of the HVOOrganization with the supplied logical ID.
Bundle: SearchResultOrganizationalUnitsWithBusinessByParentID
Examples in the Bundle:
- Bundle.entry: Specialisttandvård inom parodontologi - HVOOrganizationalUnit that matches the search
- Organization.contained: BusinessInPeriodontics - HVOBusiness that the organizational unit runs
- Organization.contained.location: Örebro tandvård - HVOLocation where the unit's business is provided
- Organization.partOf: Region Örebro HVOOrganization that the unit is a part of, as searched for
GetProviderAndHealthcareUnitForUnitById
Gets the HVOOrganization marked as healthcare provider which the unit is a part of and the HVOOrganizationalUnit marked as healthcare unit if the unit is part of one (ie. hierarchically below a HVOOrganizationalUnit with a type element set to healthcareunit).
This operation does NOT change content
| Operation name | HTTP verbs |
|---|---|
| $provider-and-healthcare-unit-for-unit-by-id | GET |
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | string | Logical ID (UUID) of HVOOrganizationalUnit |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 0..1 | Bundle | A Bundle with the HVOOrganization marked as healthcare provider which the unit is a part of and the HVOOrganizationalUnit marked as healthcare unit if the unit is part of one (ie. hierarchically below a HVOOrganizationalUnit with a type element set to healthcareunit) |
Invocations
URL: [base]/Organization/[id]/$provider-and-healthcare-unit-for-unit-by-id
Note that all example data is fictional and not actual data that can be queried.
Search for healthcare unit and provider for specified unit
Invocation
Example of seraching for healthcare unit and provider for HVOOrganizationalUnit with logical ID 123-456-678.
[base]/Organization/123-456-678/$provider-and-healthcare-unit-for-unit-by-id
Result
- Both healthcare provider and unit found
Example of result from searching for healthcare unit as HVOOrganizationalUnit and healthcare provider as HVOOrganization, that are parent organizations of unit with logical ID 123-456-678. The result is a Bundle with one HVOOrganizationalUnit and one HVOOrganization, which means that both exists as parents of the unit.
Bundle: SearchResultHealthcareUnitAndHealthcareProviderOfUnit
Examples in the Bundle:
- Bundle.entry: Specialisttandvård inom parodontologi - HVOOrganizationalUnit that is the parent healthcare unit of the supplied unit
- Bundle.entry: Region Örebro - HVOOrganization that is the healthcare provider of the supplied unit
- Only healthcare provider found
Example of result from searching for healthcare unit as HVOOrganizationalUnit and healthcare provider as HVOOrganization, that are parent organizations of unit with logical ID 321-654-987. The result is a Bundle with one HVOOrganization, which means that there is no healthcare unit above the supplied unit.
Bundle: SearchResultHealthcareProviderOfUnit
Examples in the Bundle:
- Bundle.entry: Region Örebro - HVOOrganization that is the healthcare provider of the supplied unit