CH EMED EPR
1.0.1-ci-build - ci-build
CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-organization | Version: 1.0.1-ci-build | |||
Draft as of 2024-12-04 | Computable Name: CHEMEDEPROrganization | |||
Copyright/Legal: CC0-1.0 |
Definition of the organization for the eMedication context
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | CHEMEDOrganization | |||
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
assigner | D | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
Slices for identifier | Content/Rules for all slices | |||
identifier:GLN | 0..1 | GLNIdentifier | An identifier intended for computation | |
value | C | 1..1 | string | The value that is unique gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP |
partOf | D | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
endpoint | D | 0..* | Reference(Endpoint) | ✕ This element will be removed in PML(C) documents |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | CHEMEDOrganization | CH EMED Organization org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
assigner | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
identifier:BER | 0..1 | BERIdentifier | BER (Business and Enterprise Register), BUR (Betriebs- und Unternehmensregister), REE (Registre des entreprises et des établissements), RIS (Registro delle imprese e degli stabilimenti) 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 | 0..1 | UIDBIdentifier | UIDB (Unique Identification Business), UID (Verwendung der Unternehmens-Identifikationsnummer), IDE (Utilisation du numéro d'identification des entreprises), IDI (Utilizzo del numero d'identificazione delle imprese) 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 | 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.51.1.3 | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 |
value | ΣC | 1..1 | string | The value that is unique gln-length: GLN must be exactly 13 characters long gln-modulus-10: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76: GLN must start with 76 for Swiss HCP gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
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 | 1..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' |
partOf | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
endpoint | 0..* | Reference(Endpoint) | ✕ This element will be removed in PML(C) documents | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Organization.identifier:GLN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
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 |
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()) | |
gln-length | warning | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10 | warning | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76 | warning | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
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..* | CHEMEDOrganization | CH EMED Organization 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | Σ | 0..1 | instant | ✕ This element is not supported | ||||
source | Σ | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this | ||||
identifier: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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents | ||||
identifier:BER | 0..1 | BERIdentifier | BER (Business and Enterprise Register), BUR (Betriebs- und Unternehmensregister), REE (Registre des entreprises et des établissements), RIS (Registro delle imprese e degli stabilimenti) 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 | 0..1 | UIDBIdentifier | UIDB (Unique Identification Business), UID (Verwendung der Unternehmens-Identifikationsnummer), IDE (Utilisation du numéro d'identification des entreprises), IDI (Utilizzo del numero d'identificazione delle imprese) 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 | 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.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) | |||||
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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | ||||
value | ΣC | 1..1 | string | The value that is unique gln-length: GLN must be exactly 13 characters long gln-modulus-10: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76: GLN must start with 76 for Swiss HCP gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP Example General: 123456 | ||||
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 (extensible) | ||||
name | ΣC | 0..1 | string | Name used for the organization | ||||
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 | 1..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' | ||||
partOf | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents | ||||
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) | ✕ This element will be removed in PML(C) documents | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.identifier:GLN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier:GLN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.type | extensible | 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.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
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() | |
gln-length | warning | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10 | warning | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76 | warning | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
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 CHEMEDOrganization
Differential View
This structure is derived from CHEMEDOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | CHEMEDOrganization | |||
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
assigner | D | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
Slices for identifier | Content/Rules for all slices | |||
identifier:GLN | 0..1 | GLNIdentifier | An identifier intended for computation | |
value | C | 1..1 | string | The value that is unique gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP |
partOf | D | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
endpoint | D | 0..* | Reference(Endpoint) | ✕ This element will be removed in PML(C) documents |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | CHEMEDOrganization | CH EMED Organization org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
assigner | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
identifier:BER | 0..1 | BERIdentifier | BER (Business and Enterprise Register), BUR (Betriebs- und Unternehmensregister), REE (Registre des entreprises et des établissements), RIS (Registro delle imprese e degli stabilimenti) 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 | 0..1 | UIDBIdentifier | UIDB (Unique Identification Business), UID (Verwendung der Unternehmens-Identifikationsnummer), IDE (Utilisation du numéro d'identification des entreprises), IDI (Utilizzo del numero d'identificazione delle imprese) 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 | 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.51.1.3 | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 |
value | ΣC | 1..1 | string | The value that is unique gln-length: GLN must be exactly 13 characters long gln-modulus-10: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76: GLN must start with 76 for Swiss HCP gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
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 | 1..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' |
partOf | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents |
endpoint | 0..* | Reference(Endpoint) | ✕ This element will be removed in PML(C) documents | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Organization.identifier:GLN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
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 |
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()) | |
gln-length | warning | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10 | warning | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76 | warning | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
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..* | CHEMEDOrganization | CH EMED Organization 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | Σ | 0..1 | instant | ✕ This element is not supported | ||||
source | Σ | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this | ||||
identifier: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 | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents | ||||
identifier:BER | 0..1 | BERIdentifier | BER (Business and Enterprise Register), BUR (Betriebs- und Unternehmensregister), REE (Registre des entreprises et des établissements), RIS (Registro delle imprese e degli stabilimenti) 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 | 0..1 | UIDBIdentifier | UIDB (Unique Identification Business), UID (Verwendung der Unternehmens-Identifikationsnummer), IDE (Utilisation du numéro d'identification des entreprises), IDI (Utilizzo del numero d'identificazione delle imprese) 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 | 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.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) | |||||
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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | ||||
value | ΣC | 1..1 | string | The value that is unique gln-length: GLN must be exactly 13 characters long gln-modulus-10: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76: GLN must start with 76 for Swiss HCP gln-length-error: GLN must be exactly 13 characters long gln-modulus-10-error: GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually gln-startswith76-error: GLN must start with 76 for Swiss HCP Example General: 123456 | ||||
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 (extensible) | ||||
name | ΣC | 0..1 | string | Name used for the organization | ||||
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 | 1..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' | ||||
partOf | Σ | 0..1 | Reference(Organization) | ✕ This element will be removed in PML(C) documents | ||||
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) | ✕ This element will be removed in PML(C) documents | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.identifier:GLN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier:GLN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.type | extensible | 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.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
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() | |
gln-length | warning | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-length-error | error | Organization.identifier:GLN.value | GLN must be exactly 13 characters long : matches('^[0-9]{13}$') | |
gln-modulus-10 | warning | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-modulus-10-error | error | Organization.identifier:GLN.value | GLN must pass the modulus 10 check - https://www.gs1.org/services/how-calculate-check-digit-manually : (((10-((substring(0,1).toInteger()*1)+(substring(1,1).toInteger()*3)+(substring(2,1).toInteger()*1)+(substring(3,1).toInteger()*3)+(substring(4,1).toInteger()*1)+(substring(5,1).toInteger()*3)+(substring(6,1).toInteger()*1)+(substring(7,1).toInteger()*3)+(substring(8,1).toInteger()*1)+(substring(9,1).toInteger()*3)+(substring(10,1).toInteger()*1)+(substring(11,1).toInteger()*3))mod(10))mod(10))=substring(12,1).toInteger()) | |
gln-startswith76 | warning | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
gln-startswith76-error | error | Organization.identifier:GLN.value | GLN must start with 76 for Swiss HCP : startsWith('76') | |
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 CHEMEDOrganization
Other representations of profile: CSV, Excel, Schematron