CH ELM (R4)
1.8.0-cibuild - ci-build
CH ELM (R4)
1.8.0-cibuild - ci-build
CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.8.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-practitioner-orderer | Version: 1.8.0-cibuild | |||
| Active as of 2024-12-20 | Computable Name: ChElmPractitionerOrderer | |||
Copyright/Legal: CC0-1.0 |
||||
This CH ELM base profile constrains the Practitioner resource for the orderer.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChLabPractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ |
  identifier |
S | 0..2 | Identifier | An identifier for the person as this agent |
  Slices for identifier |
Content/Rules for all slices | |||
   identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) |
 identifier:ZSR |
S | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) |
| name |
1..1 | CHCoreHumanName | Name of a human - parts and usage | |
| family |
S | 0..1 | string | Family name (often called 'Surname') Max Length:100 |
 given |
S | 0..1 | string | Given names (not always 'first'). Includes middle names Max Length:100 |
| Slices for telecom |
Content/Rules for all slices | |||
 telecom:email |
S | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email |
  value |
1..1 | string | The actual contact point details Example CH ELM: info@domain.ch Max Length:255 | |
 telecom:phone |
S | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone |
 value |
1..1 | string | The actual contact point details Example CH ELM: +41 79 999 55 66 Max Length:25 | |
 address |
S | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| city |
S | 0..1 | string | Name of city, town etc. |
| postalCode |
S | 0..1 | string | Postal code for area |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ch-pract-1: If a HumanName is provided, at least one HumanName must have a given and family name. ch-pract-2: gender unknown is currently not used in Switzerland in eCH and the EPR ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
SΣ | 0..2 | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
| identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
 system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
| identifier:ZSR |
S | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) ele-1: All FHIR elements must have a @value or children 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 | |
 name |
C | 1..1 | CHCoreHumanName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
| family |
SΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Max Length:100 |
| Slices for extension |
Content/Rules for all slices | |||
| ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| given |
SΣ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Max Length:100 |
| Slices for extension |
Content/Rules for all slices | |||
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| telecom:email |
SC | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
 system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Example CH ELM: info@domain.ch Max Length:255 |
 use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| telecom:phone |
SC | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Example CH ELM: +41 79 999 55 66 Max Length:25 |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| telecom:internet |
C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
| address |
SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| city |
SΣ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| postalCode |
SΣ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-2 | error | Practitioner.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'))) | |
| ch-core-hm-1 | error | Practitioner.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
| ch-core-hm-2 | error | Practitioner.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
| ch-core-hm-3 | error | Practitioner.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
| ch-core-hm-4 | error | Practitioner.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() | |
| ch-pract-1 | error | Practitioner | If a HumanName is provided, at least one HumanName must have a given and family name. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
| ch-pract-2 | warning | Practitioner | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
| cpt-2 | error | Practitioner.telecom:email, Practitioner.telecom:phone, Practitioner.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | Practitioner | 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 | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report ch-pract-1: If a HumanName is provided, at least one HumanName must have a given and family name. ch-pract-2: gender unknown is currently not used in Switzerland in eCH and the EPR ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ | ||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..2 | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:$this | ||||
| identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) 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) | |||||
| identifier:ZSR |
S | 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) | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
C | 1..1 | CHCoreHumanName | Name of a human - parts and usage ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name | ||||
| 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 0..1 | string | Family name (often called 'Surname') Max Length:100 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| given |
SΣ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Max Length:100 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| prefix |
Σ | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| salutationandtitle |
0..* | code | For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system | ||||
| telecom:email |
SC | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. | ||||
| 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. Fixed Value: email | ||||
| value |
Σ | 1..1 | string | The actual contact point details Example CH ELM: info@domain.ch Max Length:255 | ||||
 use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| telecom:phone |
SC | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. | ||||
| 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. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details Example CH ELM: +41 79 999 55 66 Max Length:25 | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| telecom:internet |
C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. | ||||
| 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. | ||||
| 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 |
Σ | 0..* | 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 |
0..1 | string | street part of the street line, e.g. withouth housenumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
| houseNumber |
0..1 | string | houseNumber part of the street line 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 |
0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText 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 (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"} | ||||
| gender |
Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| 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 | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Practitioner.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.state | example | ECH007CantonAbbreviationhttp://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Practitioner.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 | Practitioner.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'))) | |
| ch-core-hm-1 | error | Practitioner.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
| ch-core-hm-2 | error | Practitioner.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
| ch-core-hm-3 | error | Practitioner.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
| ch-core-hm-4 | error | Practitioner.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() | |
| ch-pract-1 | error | Practitioner | If a HumanName is provided, at least one HumanName must have a given and family name. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
| ch-pract-2 | warning | Practitioner | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
| cpt-2 | error | Practitioner.telecom:email, Practitioner.telecom:phone, Practitioner.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | Practitioner | 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 | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | 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() |
This structure is derived from ChLabPractitioner
Differential View
This structure is derived from ChLabPractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ |
| identifier |
S | 0..2 | Identifier | An identifier for the person as this agent |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) |
| identifier:ZSR |
S | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) |
| name |
1..1 | CHCoreHumanName | Name of a human - parts and usage | |
| family |
S | 0..1 | string | Family name (often called 'Surname') Max Length:100 |
| given |
S | 0..1 | string | Given names (not always 'first'). Includes middle names Max Length:100 |
| Slices for telecom |
Content/Rules for all slices | |||
| telecom:email |
S | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email |
| value |
1..1 | string | The actual contact point details Example CH ELM: info@domain.ch Max Length:255 | |
| telecom:phone |
S | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone |
| value |
1..1 | string | The actual contact point details Example CH ELM: +41 79 999 55 66 Max Length:25 | |
| address |
S | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| city |
S | 0..1 | string | Name of city, town etc. |
| postalCode |
S | 0..1 | string | Postal code for area |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ch-pract-1: If a HumanName is provided, at least one HumanName must have a given and family name. ch-pract-2: gender unknown is currently not used in Switzerland in eCH and the EPR ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
SΣ | 0..2 | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
| identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
| identifier:ZSR |
S | 0..1 | ZSRIdentifier | ZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori) ele-1: All FHIR elements must have a @value or children 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 | |
| name |
C | 1..1 | CHCoreHumanName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
| family |
SΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Max Length:100 |
| Slices for extension |
Content/Rules for all slices | |||
| ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| given |
SΣ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Max Length:100 |
| Slices for extension |
Content/Rules for all slices | |||
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| telecom:email |
SC | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Example CH ELM: info@domain.ch Max Length:255 |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| telecom:phone |
SC | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children Example CH ELM: +41 79 999 55 66 Max Length:25 |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| telecom:internet |
C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
| address |
SC | 0..1 | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children ch-addr-2: For a Swiss address, a canton abbreviation from the value set 'eCH-0007 Canton Abbreviation' must be used. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| city |
SΣ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| postalCode |
SΣ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-2 | error | Practitioner.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'))) | |
| ch-core-hm-1 | error | Practitioner.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
| ch-core-hm-2 | error | Practitioner.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
| ch-core-hm-3 | error | Practitioner.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
| ch-core-hm-4 | error | Practitioner.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() | |
| ch-pract-1 | error | Practitioner | If a HumanName is provided, at least one HumanName must have a given and family name. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
| ch-pract-2 | warning | Practitioner | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
| cpt-2 | error | Practitioner.telecom:email, Practitioner.telecom:phone, Practitioner.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | Practitioner | 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 | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | ChLabPractitioner | CH ELM Practitioner: Orderer This profile also imposes the profile Practitioner: Laboratory Report ch-pract-1: If a HumanName is provided, at least one HumanName must have a given and family name. ch-pract-2: gender unknown is currently not used in Switzerland in eCH and the EPR ch-elm-practioner-zsr-check-length: invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long ch-elm-practioner-zsr-check-digit: invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..2 | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:$this | ||||
| identifier:GLN |
S | 0..1 | GLNIdentifier | GLN (Global Location Number) 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) | |||||
| identifier:ZSR |
S | 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) | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
C | 1..1 | CHCoreHumanName | Name of a human - parts and usage ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name | ||||
| 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 0..1 | string | Family name (often called 'Surname') Max Length:100 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ech11name |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| given |
SΣ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Max Length:100 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ech11firstname |
0..1 | code | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| prefix |
Σ | 0..* | string | For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| salutationandtitle |
0..* | code | For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system | ||||
| telecom:email |
SC | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email cpt-2: A system is required if a value is provided. | ||||
| 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. Fixed Value: email | ||||
| value |
Σ | 1..1 | string | The actual contact point details Example CH ELM: info@domain.ch Max Length:255 | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| telecom:phone |
SC | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone cpt-2: A system is required if a value is provided. | ||||
| 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. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details Example CH ELM: +41 79 999 55 66 Max Length:25 | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| telecom:internet |
C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet cpt-2: A system is required if a value is provided. | ||||
| 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. | ||||
| 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 |
Σ | 0..* | 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 |
0..1 | string | street part of the street line, e.g. withouth housenumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
| houseNumber |
0..1 | string | houseNumber part of the street line 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 |
0..1 | string | Optional postOfficeBoxNumber as a separate part of the postOfficeBoxText 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 (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"} | ||||
| gender |
Σ | 0..1 | code | male | female | other Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| 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 | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Practitioner.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:phone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.line.extension:addressLine1.value[x]:valueCode | extensible | Fixed Value: addressLine1http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:addressLine2.value[x]:valueCode | extensible | Fixed Value: addressLine2http://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:street.value[x]:valueCode | extensible | Fixed Value: streethttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.line.extension:postOfficeBoxText.value[x]:valueCode | extensible | Fixed Value: postOfficeBoxTexthttp://fhir.ch/ig/ch-core/ValueSet/ech-10-linetype | ||||
| Practitioner.address.state | example | ECH007CantonAbbreviationhttp://fhir.ch/ig/ch-core/ValueSet/ech-7-cantonabbreviation | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| ch-addr-1 | error | Practitioner.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 | Practitioner.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'))) | |
| ch-core-hm-1 | error | Practitioner.name | if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official') | |
| ch-core-hm-2 | error | Practitioner.name | if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden : family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden')) | |
| ch-core-hm-3 | error | Practitioner.name | ch-ext-ech-11-name can only be put on a family name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count() | |
| ch-core-hm-4 | error | Practitioner.name | ch-ext-ech-11-firstname can only be put on a given name : descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count() | |
| ch-elm-practioner-zsr-check-digit | warning | Practitioner | invalid ZSR number, cannot be processed, must pass the modulus 26 check - https://confluence.sasis.ch/display/PublicZSR/ZSR+Webservice+FAQ : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.select(((substring(1,1).toInteger()*6)+(substring(2,1).toInteger()*5)+(substring(3,1).toInteger()*4)+(substring(4,1).toInteger()*3)+(substring(5,1).toInteger()*2)+(substring(6,1).toInteger()))mod(26)=iif(substring(0,1)='A',1,iif(substring(0,1)='B',2,iif(substring(0,1)='C',3,iif(substring(0,1)='D',4,iif(substring(0,1)='E',5,iif(substring(0,1)='F',6,iif(substring(0,1)='G',7,iif(substring(0,1)='H',8,iif(substring(0,1)='I',9,iif(substring(0,1)='J',10,iif(substring(0,1)='K',11,iif(substring(0,1)='L',12,iif(substring(0,1)='M',13,iif(substring(0,1)='N',14,iif(substring(0,1)='O',15,iif(substring(0,1)='P',16,iif(substring(0,1)='Q',17,iif(substring(0,1)='R',18,iif(substring(0,1)='S',19,iif(substring(0,1)='T',20,iif(substring(0,1)='U',21,iif(substring(0,1)='V',22,iif(substring(0,1)='W',23,iif(substring(0,1)='X',24,iif(substring(0,1)='Y',25,iif(substring(0,1)='Z',26,-1))))))))))))))))))))))))))).allTrue() | |
| ch-elm-practioner-zsr-check-length | warning | Practitioner | invalid ZSR number, cannot be processed, must be exactly one letter and 6 digits long : identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').exists() implies identifier.where(system='urn:oid:2.16.756.5.30.1.123.100.2.1.1').value.matches('^[A-Z][0-9]{6}$').allTrue() | |
| ch-pract-1 | error | Practitioner | If a HumanName is provided, at least one HumanName must have a given and family name. : name.where(family.exists() and given.exists()).count()>0 or name.empty() | |
| ch-pract-2 | warning | Practitioner | gender unknown is currently not used in Switzerland in eCH and the EPR : gender.empty() or gender!='unknown' | |
| cpt-2 | error | Practitioner.telecom:email, Practitioner.telecom:phone, Practitioner.telecom:internet | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | Practitioner | 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 | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | 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() |
This structure is derived from ChLabPractitioner
Other representations of profile: CSV, Excel, Schematron