CH ELM (R4)
1.7.0 - release
This page is part of the Observations of notifiable communicable infectious diseases (v1.7.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-organization-orderer | Version: 1.7.0 | |||
Active as of 2024-11-28 | Computable Name: ChElmOrganizationOrderer | |||
Copyright/Legal: CC0-1.0 |
This CH ELM base profile constrains the Organization resource for the orderer.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | CHCoreOrganization | CH ELM Organization: Orderer | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department |
identifier | S | 0..* | Identifier | Identifies this organization across multiple systems |
Slices for identifier | Content/Rules for all slices | |||
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation |
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation |
name | S | 0..1 | string | Name used for the organization Max Length:100 |
address | S | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
Slices for extension | Content/Rules for all slices | |||
extension:streetName | S | 0..1 | ADXPStreetName(5.1.0) | streetName |
extension:houseNumber | S | 0..1 | ADXPHouseNumber(5.1.0) | houseNumber |
extension:postOfficeBoxNumber | S | 0..1 | ADXPPostBox(5.1.0) | postBox |
city | S | 0..1 | string | Name of city, town etc. |
postalCode | S | 0..1 | string | Postal code for area |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | CHCoreOrganization | CH ELM Organization: Orderer org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.45 | |
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.35 | |
identifier:ZSR | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
identifier:GLN | 0..1 | GLNIdentifier | Global Location Number (GLN) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
name | SΣC | 0..1 | string | Name used for the organization Max Length:100 |
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system org-3: The telecom of an organization can never be of use 'home' |
telecom:All Slices | Content/Rules for all slices | |||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
address | SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. org-2: An address of an organization can never be of use 'home' |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
Slices for extension | Content/Rules for all slices | |||
addressLine1 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1 | |
addressLine2 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2 | |
street | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street | |
streetName | S | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName |
houseNumber | S | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber |
unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
postOfficeBoxText | 0..1 | (Complex) | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText | |
postOfficeBoxNumber | S | 0..1 | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
Slices for extension | Content/Rules for all slices | |||
bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Organization.address | 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'))) | |
cpt-2 | error | Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CHCoreOrganization | CH ELM Organization: Orderer org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.45 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.35 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:ZSR | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:GLN | 0..1 | GLNIdentifier | Global Location Number (GLN) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) | ||||
name | SΣC | 0..1 | string | Name used for the organization Max Length:100 | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
address | SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. org-2: An address of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |||||
addressLine1 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1 | |||||
addressLine2 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2 | |||||
street | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street | |||||
streetName | S | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | ||||
houseNumber | S | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | ||||
unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |||||
postOfficeBoxText | 0..1 | (Complex) | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText | |||||
postOfficeBoxNumber | S | 0..1 | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | preferred | DocumentEntryHealthcareFacilityTypeCodehttp://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Organization.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.state | example | ECH007CantonFLAbbreviationhttp://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-1 | error | Organization.address.country.extension:countrycode | 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')) | |
ch-addr-2 | error | Organization.address | 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'))) | |
cpt-2 | error | Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from CHCoreOrganization
Differential View
This structure is derived from CHCoreOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | CHCoreOrganization | CH ELM Organization: Orderer | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department |
identifier | S | 0..* | Identifier | Identifies this organization across multiple systems |
Slices for identifier | Content/Rules for all slices | |||
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation |
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation |
name | S | 0..1 | string | Name used for the organization Max Length:100 |
address | S | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
Slices for extension | Content/Rules for all slices | |||
extension:streetName | S | 0..1 | ADXPStreetName(5.1.0) | streetName |
extension:houseNumber | S | 0..1 | ADXPHouseNumber(5.1.0) | houseNumber |
extension:postOfficeBoxNumber | S | 0..1 | ADXPPostBox(5.1.0) | postBox |
city | S | 0..1 | string | Name of city, town etc. |
postalCode | S | 0..1 | string | Postal code for area |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | CHCoreOrganization | CH ELM Organization: Orderer org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.45 | |
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.35 | |
identifier:ZSR | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
identifier:GLN | 0..1 | GLNIdentifier | Global Location Number (GLN) Required Pattern: At least the following | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
name | SΣC | 0..1 | string | Name used for the organization Max Length:100 |
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system org-3: The telecom of an organization can never be of use 'home' |
telecom:All Slices | Content/Rules for all slices | |||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' |
address | SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. org-2: An address of an organization can never be of use 'home' |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
Slices for extension | Content/Rules for all slices | |||
addressLine1 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1 | |
addressLine2 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2 | |
street | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street | |
streetName | S | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName |
houseNumber | S | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber |
unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |
postOfficeBoxText | 0..1 | (Complex) | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText | |
postOfficeBoxNumber | S | 0..1 | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
Slices for extension | Content/Rules for all slices | |||
bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | |
Organization.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-2 | error | Organization.address | 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'))) | |
cpt-2 | error | Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CHCoreOrganization | CH ELM Organization: Orderer org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
department | S | 0..1 | string | CH ELM Extension: Department URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-department | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:BER | S | 0..1 | BERIdentifier | An identifier intended for computation Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.45 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:UIDB | S | 0..1 | UIDBIdentifier | An identifier intended for computation Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.35 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:ZSR | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:GLN | 0..1 | GLNIdentifier | Global Location Number (GLN) Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) | ||||
name | SΣC | 0..1 | string | Name used for the organization Max Length:100 | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
Slices for telecom | C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. org-3: The telecom of an organization can never be of use 'home' | ||||
address | SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. org-2: An address of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Ordered, Open by value:url, value:value | |||||
addressLine1 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine1 | |||||
addressLine2 | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: addressLine2 | |||||
street | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: street | |||||
streetName | S | 0..1 | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | ||||
houseNumber | S | 0..1 | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | ||||
unitID | 0..1 | string | unitID, dwellingNumber part of the street line URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |||||
postOfficeBoxText | 0..1 | (Complex) | Postbox addresses need an postbox text and optional postbox number URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype" | |||||
Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCode | 1..1 | code | Value of extension Binding: eCH-010 Address Line Type (extensible) Fixed Value: postOfficeBoxText | |||||
postOfficeBoxNumber | S | 0..1 | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
bfs | 0..1 | string | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid | |||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: eCH-0007 Canton Abbreviation incl. FL (Fürstentum Liechtenstein) (example): Use these values for a Swiss or Liechtenstein address | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
countrycode | C | 0..1 | Coding | ISO Country Alpha-2 or ISO Country Alpha-3 code URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding Binding Description (No ValueSet): (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. ch-addr-1: ISO Country Alpha-2 or ISO Country Alpha-3 code | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | preferred | DocumentEntryHealthcareFacilityTypeCodehttp://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Organization.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
Organization.address.state | example | ECH007CantonFLAbbreviationhttp://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonflabbreviation | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-addr-1 | error | Organization.address.country.extension:countrycode | 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')) | |
ch-addr-2 | error | Organization.address | 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'))) | |
cpt-2 | error | Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:email, Organization.telecom:phone, Organization.telecom:internet | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from CHCoreOrganization
Other representations of profile: CSV, Excel, Schematron