CH ELM Organization: Orderer - Definitions

Is Modifier false

Summary true

4. Organization.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Organization.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Organization.language

Definition

The base language in which the resource is written.

Short Language of the resource content

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

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Organization.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Organization.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Organization.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Organization.extension:department

Slice Name department

Definition

This CH ELM extension enables the representation of a department (name) of an organization directly in the resource Organization itself.

Short CH ELM Extension: Department

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(CH ELM Extension: Department) (Extension Type: string)

Is Modifier false

Must Support true

18. Organization.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

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.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

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.

Alternate Names extensions, user content

20. Organization.identifier

Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Short Identifies this organization across multiple systems

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*
This element is affected by the following invariants: org-1

Identifier

Is Modifier false

Must Support true

Summary true

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

pattern @ $this

22. Organization.identifier:BER

Slice Name BER

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Short An identifier intended for computation

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1
This element is affected by the following invariants: ele-1

Type Identifier(BER Identifier)

Is Modifier false

Must Support 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.

Pattern Value { "system" : "urn:oid:2.16.756.5.45" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

24. Organization.identifier:UIDB

Slice Name UIDB

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Short An identifier intended for computation

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1
This element is affected by the following invariants: ele-1

Type Identifier(UIDB Identifier)

Is Modifier false

Must Support 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.

Pattern Value { "system" : "urn:oid:2.16.756.5.35" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. Organization.identifier:ZSR

Slice Name ZSR

Definition

See ZSR/RCC

Short ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori)

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1
This element is affected by the following invariants: ele-1

Type Identifier(ZSR Identifier)

Is Modifier false

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.

Pattern Value { "system" : "urn:oid:2.16.756.5.30.1.123.100.2.1.1" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. Organization.identifier:GLN

Slice Name GLN

Definition

See GLN

Short Global Location Number (GLN)

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1
This element is affected by the following invariants: ele-1

Type Identifier(GLN Identifier)

Is Modifier false

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.

Pattern Value { "system" : "urn:oid:2.51.1.3" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

30. Organization.active

Definition

Whether the organization's record is still in active use.

Short Whether the organization's record is still in active use

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.

Control 0..1

boolean

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

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.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

32. Organization.type

Definition

The kind(s) of organization that this is.

Short Kind of organization

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.

Control 0..*

Binding The codes SHOULD be taken from DocumentEntry.healthcareFacilityTypeCode
(preferred to http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode)

CodeableConcept

Is Modifier false

Summary true

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

34. Organization.name

Definition

A name associated with the organization.

Short Name used for 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.

Control 0..1
This element is affected by the following invariants: org-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to use the name as the label of the organization.

Max Length: 100

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. Organization.alias

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Short A list of alternate names that the organization is known as, or was known as in the past

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.

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. Organization.telecom

Definition

A contact detail for the organization.

Short A contact detail for the organization

Comments

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Control 0..*
This element is affected by the following invariants: org-3

ContactPoint

Is Modifier false

Summary false

Requirements

Human contact for the organization.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())

This element introduces a set of slices on Organization.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

40. Organization.telecom.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

42. Organization.telecom.extension

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

44. Organization.telecom.system

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short phone | fax | email | pager | url | sms | other

Control 1..1
This element is affected by the following invariants: cpt-2

The codes SHALL be taken from ContactPointSystem
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

Telecommunications form for contact point.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. Organization.telecom.value

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Short The actual contact point details

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. Organization.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUse
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. Organization.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control 0..1

positiveInt

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. Organization.telecom.period

Definition

Time period when the contact point was/is in use.

Short Time period when the contact point was/is in use

Control 0..1

Period

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Organization.telecom:email

Slice Name email

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Short CH Core ContactPoint eCH-0046 Email

Comments

Control 0..*
This element is affected by the following invariants: ele-1

Type ContactPoint(CH Core ContactPoint eCH-0046 Email)

Is Modifier false

Requirements

Human contact for the organization.

Invariants cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())

56. Organization.telecom:phone

Slice Name phone

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Short CH Core ContactPoint eCH-0046 Phone

Comments

Control 0..*
This element is affected by the following invariants: ele-1

Type ContactPoint(CH Core ContactPoint eCH-0046 Phone)

Is Modifier false

Requirements

Human contact for the organization.

58. Organization.telecom:internet

Slice Name internet

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Short CH Core ContactPoint eCH-0046 Internet

Comments

Control 0..*
This element is affected by the following invariants: ele-1

Type ContactPoint(CH Core ContactPoint eCH-0046 Internet)

Is Modifier false

Requirements

Human contact for the organization.

60. Organization.address

Definition

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

Short An address expressed using postal conventions (as opposed to GPS or other location definition formats)

Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control 0..1
This element is affected by the following invariants: ele-1

Type Address(CH Core Address)

Is Modifier false

Must Support true

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').empty() or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH') = false) or (country.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding').value.code.startsWith('CH').exists() and (state.empty() or state.memberOf('http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation'))))
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())

62. Organization.address.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

64. Organization.address.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

66. Organization.address.use

Definition

The purpose of this address.

Short home | work | temp | old | billing - purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General:home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. Organization.address.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short postal | physical | both

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

Control 0..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General:both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. Organization.address.text

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Short Text representation of the address

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General:137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. Organization.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Short Street name, number, direction & P.O. Box etc.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General:137 Nowhere Street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. Organization.address.line.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

76. Organization.address.line.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.line.extension. The slices areOrdered and Open, and can be differentiated using the following discriminators:

value @ url

value @ value

78. Organization.address.line.extension:addressLine1

Slice Name addressLine1

Definition

eCH-0010: Extension to define line types for an address

Short Extension

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Address Line Type) (Extension Type: code)

Is Modifier false

80. Organization.address.line.extension:addressLine1.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

82. Organization.address.line.extension:addressLine1.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

84. Organization.address.line.extension:addressLine1.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

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.

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype

86. Organization.address.line.extension:addressLine1.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Organization.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

88. Organization.address.line.extension:addressLine1.value[x]:valueCode

Slice Name valueCode

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Short Value of extension

Control 1..1

Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
(extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

A set of codes advising a system or user which name in a set of names to select for a given purpose.

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Fixed Value addressLine1

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. Organization.address.line.extension:addressLine2

Slice Name addressLine2

Definition

eCH-0010: Extension to define line types for an address

Short Extension

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Address Line Type) (Extension Type: code)

Is Modifier false

92. Organization.address.line.extension:addressLine2.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

94. Organization.address.line.extension:addressLine2.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

96. Organization.address.line.extension:addressLine2.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype

98. Organization.address.line.extension:addressLine2.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Organization.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

100. Organization.address.line.extension:addressLine2.value[x]:valueCode

Slice Name valueCode

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Short Value of extension

Control 1..1

Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
(extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

A set of codes advising a system or user which name in a set of names to select for a given purpose.

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Fixed Value addressLine2

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. Organization.address.line.extension:street

Slice Name street

Definition

eCH-0010: Extension to define line types for an address

Short Extension

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Address Line Type) (Extension Type: code)

Is Modifier false

104. Organization.address.line.extension:street.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

106. Organization.address.line.extension:street.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

108. Organization.address.line.extension:street.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype

110. Organization.address.line.extension:street.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Organization.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

112. Organization.address.line.extension:street.value[x]:valueCode

Slice Name valueCode

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Short Value of extension

Control 1..1

Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
(extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

A set of codes advising a system or user which name in a set of names to select for a given purpose.

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Fixed Value street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Organization.address.line.extension:streetName

Slice Name streetName

Definition

streetName.

Short streetName

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP-streetName) (Extension Type: string)

Is Modifier false

Must Support true

116. Organization.address.line.extension:houseNumber

Slice Name houseNumber

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP-houseNumber) (Extension Type: string)

Is Modifier false

Must Support true

118. Organization.address.line.extension:unitID

Slice Name unitID

Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Short unitID, dwellingNumber part of the street line

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP-unitID) (Extension Type: string)

Is Modifier false

120. Organization.address.line.extension:postOfficeBoxText

Slice Name postOfficeBoxText

Definition

eCH-0010: Extension to define line types for an address

Short Postbox addresses need an postbox text and optional postbox number

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Address Line Type) (Extension Type: code)

Is Modifier false

122. Organization.address.line.extension:postOfficeBoxText.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

124. Organization.address.line.extension:postOfficeBoxText.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

126. Organization.address.line.extension:postOfficeBoxText.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype

128. Organization.address.line.extension:postOfficeBoxText.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Organization.address.line.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

130. Organization.address.line.extension:postOfficeBoxText.value[x]:valueCode

Slice Name valueCode

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Short Value of extension

Control 1..1

Unless not suitable, these codes SHALL be taken from eCH-010 Address Line Type
(extensible to http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype)

A set of codes advising a system or user which name in a set of names to select for a given purpose.

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Fixed Value postOfficeBoxText

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. Organization.address.line.extension:postOfficeBoxNumber

Slice Name postOfficeBoxNumber

Definition

A numbered box located in a post station.

Short postBox

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP-postBox) (Extension Type: string)

Is Modifier false

Must Support true

134. Organization.address.line.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

136. Organization.address.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short Name of city, town etc.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General:Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. Organization.address.city.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

140. Organization.address.city.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

142. Organization.address.city.extension:bfs

Slice Name bfs

Definition

Extension for eCH-0011 - bfs number (ministry of statistics number)

Short Extension

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(eCH-0007 Municipality Id – BFS Gemeindenummer) (Extension Type: string)

Is Modifier false

144. Organization.address.city.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

146. Organization.address.district

Definition

The name of the administrative area (county).

Short District name (aka 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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General:Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. Organization.address.state

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Short Sub-unit of country (abbreviations ok)

Control 0..1

For example codes, see eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein)
(example to http://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation)

Use these values for a Swiss or Liechtenstein address

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

150. Organization.address.postalCode

Definition

A postal code designating a region defined by the postal service.

Short Postal code for area

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General:9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

152. Organization.address.country

Definition

Country - a nation as commonly understood or generally accepted.

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

154. Organization.address.country.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

156. Organization.address.country.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Organization.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

158. Organization.address.country.extension:countrycode

Slice Name countrycode

Definition

The content of the country code element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, if the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.

Short ISO Country Alpha-2 or ISO Country Alpha-3 code

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(SC-coding) (Extension Type: Coding)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code (((value.code.length()=2) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((value.code.length() = 3) and value.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))

160. Organization.address.country.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

162. Organization.address.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Period

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General:{ "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

164. Organization.partOf

Definition

The organization of which this organization forms a part.

Short The organization of which this organization forms a part

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. Organization.contact

Definition

Contact for the organization for a certain purpose.

Short Contact for the organization for a certain purpose

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Control 0..*

BackboneElement

Is Modifier false

Summary false

Requirements

Need to keep track of assigned contact points within bigger organization.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

168. Organization.contact.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

170. Organization.contact.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

172. Organization.contact.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

174. Organization.contact.purpose

Definition

Indicates a purpose for which the contact can be reached.

Short The type of contact

Control 0..1

Unless not suitable, these codes SHALL be taken from ContactEntityType
(extensible to http://hl7.org/fhir/ValueSet/contactentity-type)

The purpose for which you would contact a contact party.

CodeableConcept

Is Modifier false

Summary false

Requirements

Need to distinguish between multiple contact persons.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. Organization.contact.name

Definition

A name associated with the contact.

Short A name associated with the contact

Control 0..1

HumanName

Is Modifier false

Summary false

Requirements

Need to be able to track the person by name.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

178. Organization.contact.telecom

Definition

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Short Contact details (telephone, email, etc.) for a contact

Control 0..*

ContactPoint

Is Modifier false

Summary false

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

180. Organization.contact.address

Definition

Visiting or postal addresses for the contact.

Short Visiting or postal addresses for the contact

Control 0..1