CH Core (R4)
2.1.0 - STU 3 Ballot
This page is part of the CH Core (R4) (v2.1.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner | Version: 2.1.0 | |||
Active as of 2018-12-05 | Computable Name: CHCorePractitioner | |||
Copyright/Legal: CC-BY-SA-4.0 |
Core practitioner definition in the swiss context.
Core practitioner data which can be shared
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | I | 0..* | Practitioner | CH Core Practitioner 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 |
Slices for identifier | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:system | |
identifier:GLN | 0..* | GLNIdentifier | GLN (Global Location Number) | |
identifier:ZSR | 0..* | Identifier | ZSR | |
system | 1..1 | uri | oid of the ZSR Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
value | 1..1 | string | ZSR of the practitioner | |
name | 0..* | CHCoreHumanName | The name(s) associated with the practitioner | |
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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 |
communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | I | 0..* | Practitioner | CH Core Practitioner 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 | ||||
id | Σ | 0..1 | string | 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 | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:system | ||||
identifier:GLN | 0..* | GLNIdentifier | GLN (Global Location Number) | |||||
identifier:ZSR | Σ | 0..* | Identifier | ZSR | ||||
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 | oid of the ZSR Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | ||||
value | Σ | 1..1 | string | ZSR of the practitioner 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 this practitioner's record is in active use | ||||
name | I | 0..* | CHCoreHumanName | The name(s) associated with the practitioner | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | I | 0..* | Practitioner | CH Core Practitioner 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 |
Documentation for this format |
This structure is derived from Practitioner
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | I | 0..* | Practitioner | CH Core Practitioner 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 |
Slices for identifier | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:system | |
identifier:GLN | 0..* | GLNIdentifier | GLN (Global Location Number) | |
identifier:ZSR | 0..* | Identifier | ZSR | |
system | 1..1 | uri | oid of the ZSR Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
value | 1..1 | string | ZSR of the practitioner | |
name | 0..* | CHCoreHumanName | The name(s) associated with the practitioner | |
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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 |
communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | I | 0..* | Practitioner | CH Core Practitioner 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 | ||||
id | Σ | 0..1 | string | 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 | Σ | 0..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by value:system | ||||
identifier:GLN | 0..* | GLNIdentifier | GLN (Global Location Number) | |||||
identifier:ZSR | Σ | 0..* | Identifier | ZSR | ||||
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 | oid of the ZSR Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | ||||
value | Σ | 1..1 | string | ZSR of the practitioner 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 this practitioner's record is in active use | ||||
name | I | 0..* | CHCoreHumanName | The name(s) associated with the practitioner | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
address | 0..* | CHCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Practitioner.language | preferred | CommonLanguages Max Binding: AllLanguages |
Practitioner.identifier:ZSR.use | required | IdentifierUse |
Practitioner.identifier:ZSR.type | extensible | Identifier Type Codes |
Practitioner.gender | required | AdministrativeGender |
Practitioner.qualification.code | example | v2.0360.2.7 |
Practitioner.communication | preferred | CommonLanguages Max Binding: AllLanguages |
Id | Grade | Path | Details | Requirements |
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() | |
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' | |
ele-1 | error | Practitioner.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Practitioner.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Practitioner.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Practitioner.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Practitioner.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:GLN | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Practitioner.identifier:ZSR.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Practitioner.identifier:ZSR.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.identifier:ZSR.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
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 valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='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 valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='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() | |
ele-1 | error | Practitioner.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.qualification | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.qualification.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Practitioner.qualification.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Practitioner.qualification.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Practitioner.qualification.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Practitioner.qualification.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.qualification.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.qualification.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.qualification.issuer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Practitioner.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |