| EmigaPractitioner (Practitioner) | C | | Practitioner | There are no (further) constraints on this element Element idPractitioner Short descriptionA person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
Data typePractitioner Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: 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-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
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-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: Entity. Role, or Act
- v2: PRD (as one example)
- rim: Role
- servd: Provider
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitioner.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| meta | S Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeMeta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.meta.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitioner.meta.versionId Short descriptionVersion specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
CommentsThe server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idPractitioner.meta.lastUpdated Short descriptionWhen the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed.
CommentsThis value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Data typeinstant ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.meta.source Short descriptionIdentifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
CommentsIn the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| profile | S Σ | 1..* | canonical(StructureDefinition) | Element idPractitioner.meta.profile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Data typecanonical(StructureDefinition) SlicingUnordered, Open, by $this(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| emigaprofile | S Σ | 1..1 | canonical(StructureDefinition)Pattern | Element idPractitioner.meta.profile:emigaprofile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Data typecanonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patternhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPractitioner Mappings |
| security | S Σ | 2..* | CodingBinding | Element idPractitioner.meta.security Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
CommentsThe security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding SlicingUnordered, Open, by system(Value) Slicing security attribute by coding system BindingSecurity Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| visibility | S Σ | 1..1 | CodingBinding | Element idPractitioner.meta.security:visibility Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
CommentsThe security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. EinrVResourceVisibilityTypeVS (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ | 1..1 | uriPattern | Element idPractitioner.meta.security:visibility.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patternhttps://emiga.rki.de/fhir/common/CodeSystem/ResourceVisibilityType Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.version Short descriptionVersion of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.code Short descriptionSymbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
RequirementsNeed to refer to a particular code in the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.meta.security:visibility.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| responsibility | S Σ | 1..1 | CodingBinding | Element idPractitioner.meta.security:responsibility Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
CommentsThe security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. ResourceResponsibility (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ | 1..1 | uriPattern | Element idPractitioner.meta.security:responsibility.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patternhttps://emiga.rki.de/fhir/common/CodeSystem/ResourceResponsibility Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.version Short descriptionVersion of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.code Short descriptionSymbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
RequirementsNeed to refer to a particular code in the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.meta.security:responsibility.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| tag | S Σ | 0..* | Coding | Element idPractitioner.meta.tag Short descriptionTags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
CommentsThe tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding SlicingUnordered, Open, by system(Pattern) BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| relevance | S Σ | 0..* | CodingBinding | Element idPractitioner.meta.tag:relevance Short descriptionTags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
CommentsThe tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Relevance (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ | 1..1 | uriPattern | Element idPractitioner.meta.tag:relevance.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patternhttps://emiga.rki.de/fhir/common/CodeSystem/Relevance Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.version Short descriptionVersion of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.code Short descriptionSymbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
RequirementsNeed to refer to a particular code in the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.meta.tag:relevance.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idPractitioner.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingA human language. CommonLanguages (preferred) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| text | | 0..0 | Narrative | There are no (further) constraints on this element Element idPractitioner.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..0 | Resource | There are no (further) constraints on this element Element idPractitioner.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPractitioner.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idPractitioner.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier Short descriptionAn identifier for the person as this agent DefinitionAn identifier that applies to this person in this role.
RequirementsOften, specific identities are assigned for the agent.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: PRD-7 (or XCN.1)
- rim: ./id
- servd: ./Identifiers
|
| active | S Σ | 1..1 | boolean | Element idPractitioner.active Short descriptionWhether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use.
RequirementsNeed to be able to mark a practitioner record as not to be used because it was created in error.
CommentsDer entsprechende Eintrag muss gepflegt werden, um eindeutig feststellen zu können, ob ein Eintrag noch aktiv ist.
Meaning when missingThis resource is generally assumed to be active if no value is provided for the active element
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- w5: FiveWs.status
- rim: ./statusCode
|
| name | S Σ C | 1..1 | HumannameDeBasis | Element idPractitioner.name Short descriptionPersonenname DefinitionPersonenname mit in Deutschland üblichen Erweiterungen
RequirementsThe name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
CommentsNames may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
Data typeHumannameDeBasis ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue() - hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue() - hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue() - hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue()) Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: XCN Components
- rim: ./name
- servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.name.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.name.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
RequirementsAllows the appropriate name for a particular context of use to be selected from among a set of names.
CommentsApplications can assume that a name is current unless it explicitly says that it is temporary or old.
Data typecode BindingThe use of a human name. NameUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XPN.7, but often indicated by which field contains the name
- rim: unique(./use)
- servd: ./NamePurpose
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.text Short descriptionText representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: implied by XPN.11
- rim: ./formatted
|
| family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.name.family Short descriptionFamilienname Alternate namessurname DefinitionDer vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.
CommentsFamily Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.family.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.name.family.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| namenszusatz | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPractitioner.name.family.extension:namenszusatz Short descriptionNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate namesextensions, user content DefinitionNamenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert.
Beispiele: Gräfin, Prinz oder Fürst
CommentsDie Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt.
Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.
Data typeExtension(string) Extension URLHumannameNamenszusatz ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.family.extension:namenszusatz.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPractitioner.name.family.extension:namenszusatz.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.name.family.extension:namenszusatz.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri Fixed valuehttp://fhir.de/StructureDefinition/humanname-namenszusatz Mappings |
| value[x] | C | 0..1 | | Element idPractitioner.name.family.extension:namenszusatz.value[x] Short descriptionNamenszusatz DefinitionNamenszusatz zum Nachnamen z.B. Gräfin, Prinz oder Fürst
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$') Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| nachname | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPractitioner.name.family.extension:nachname Short descriptionNachname ohne Vor- und Zusätze Alternate namesextensions, user content DefinitionNachname ohne Vor- und Zusätze.
Dient z.B. der alphabetischen Einordnung des Namens.
CommentsIf the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Data typeExtension(string) Extension URLown-name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: N/A
- v2: FN.3
- rim: ENXP where Qualifiers = (BR)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.family.extension:nachname.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPractitioner.name.family.extension:nachname.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.name.family.extension:nachname.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings |
| value[x] | C | 1..1 | | Element idPractitioner.name.family.extension:nachname.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$') Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| vorsatzwort | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPractitioner.name.family.extension:vorsatzwort Short descriptionVorsatzwort Alternate namesextensions, user content DefinitionVorsatzwort wie z.B.: von, van, zu
Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK")
CommentsAn example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
Data typeExtension(string) Extension URLown-prefix ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: N/A
- v2: FN.2
- rim: ENXP where Qualifiers = (VV, R)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.family.extension:vorsatzwort.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPractitioner.name.family.extension:vorsatzwort.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.name.family.extension:vorsatzwort.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings |
| value[x] | C | 1..1 | | Element idPractitioner.name.family.extension:vorsatzwort.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$') Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPractitioner.name.family.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
Data typeSystem.String Maximum string length1048576 |
| given | S Σ C | 1..* | string | Element idPractitioner.name.given Short descriptionVorname Alternate namesfirst name, middle name DefinitionCommentsIf only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$') Mappings- rim: n/a
- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
|
| prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.name.prefix Short descriptionNamensteile vor dem Vornamen DefinitionNamensteile vor dem Vornamen, z.B. akademischer Titel.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.name.prefix.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.name.prefix.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| prefix-qualifier | C | 0..1 | Extension(code) | There are no (further) constraints on this element Element idPractitioner.name.prefix.extension:prefix-qualifier Short descriptionLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionSpezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel
CommentsUsed to indicate additional information about the name part and how it should be used.
Data typeExtension(code) Extension URLEN-qualifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: N/A
- rim: ENXP.qualifier
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPractitioner.name.prefix.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
Data typeSystem.String Maximum string length1048576 |
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.name.suffix Short descriptionNamensteile nach dem Nachnamen DefinitionNamensteile nach dem Nachnamen
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XPN/4
- rim: ./part[partType = SFX]
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.name.period Short descriptionTime period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person.
RequirementsAllows names to be placed in historical context.
CommentsA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| telecom | S Σ C | 0..* | ContactPoint | Element idPractitioner.telecom Short descriptionA contact detail for the practitioner (that apply to all roles) DefinitionKontaktangaben der Organisation. Telefonnummern, E-Mailadressen, Urls und Faxnummern können angegeben werden.
RequirementsNeed to know how to reach a practitioner independent to any roles the practitioner may have.
CommentsPerson may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Data typeContactPoint SlicingUnordered, Closed, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PRT-15, STF-10, ROL-12
- rim: ./telecom
- servd: ./ContactPoints
|
| Email | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:Email Short descriptionA contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address.
RequirementsNeed to know how to reach a practitioner independent to any roles the practitioner may have.
CommentsPerson may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Data typeContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PRT-15, STF-10, ROL-12
- rim: ./telecom
- servd: ./ContactPoints
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:Email.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.telecom:Email.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:Email.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valueemail Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | Element idPractitioner.telecom:Email.value Short descriptionThe actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validEmailAddress: Die E-Mail-Adresse muss valide sein.
$this.matches('^[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+[.])+[a-zA-Z0-9]{2,63}$') Mappings- rim: n/a
- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.telecom:Email.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingUse of contact point. ContactPointUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:Email.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:Email.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
CommentsA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| Phone | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:Phone Short descriptionA contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address.
RequirementsNeed to know how to reach a practitioner independent to any roles the practitioner may have.
CommentsPerson may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Data typeContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PRT-15, STF-10, ROL-12
- rim: ./telecom
- servd: ./ContactPoints
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:Phone.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.telecom:Phone.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:Phone.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valuephone Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | Element idPractitioner.telecom:Phone.value Short descriptionThe actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validPhoneNumber: Die Telefonnummer muss valide sein.
$this.matches('^(( ?\\+[0-9]{2,4}( ?[0-9]+? ?| ? \\([0-9]+?\\) ?))|(\\(0[0-9 ]+?\\) ?)|( 0[0-9]+? ?( |-|\/) ?))? ?[0-9]+?[0-9 \/-]*[0-9]$') Mappings- rim: n/a
- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.telecom:Phone.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingUse of contact point. ContactPointUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:Phone.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:Phone.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
CommentsA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| Fax | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:Fax Short descriptionA contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address.
RequirementsNeed to know how to reach a practitioner independent to any roles the practitioner may have.
CommentsPerson may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Data typeContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PRT-15, STF-10, ROL-12
- rim: ./telecom
- servd: ./ContactPoints
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:Fax.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.telecom:Fax.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| system | S Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:Fax.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valuefax Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | Element idPractitioner.telecom:Fax.value Short descriptionThe actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validFaxNumber: Die Faxnummer muss valide sein.
$this.matches('^(( ?\\+[0-9]{2,4}( ?[0-9]+? ?| ? \\([0-9]+?\\) ?))|(\\(0[0-9 ]+?\\) ?)|( 0[0-9]+? ?( |-|\/) ?))? ?[0-9]+?[0-9 \/-]*[0-9]$') Mappings- rim: n/a
- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.telecom:Fax.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingUse of contact point. ContactPointUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:Fax.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:Fax.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
CommentsA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| address | Σ | 0..0 | Address | There are no (further) constraints on this element Element idPractitioner.address Short descriptionAddress(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address).
Work addresses are not typically entered in this property as they are usually role dependent.
RequirementsThe home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
CommentsThe PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
Data typeAddress ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
- v2: ORC-24, STF-11, ROL-11, PRT-14
- rim: ./addr
- servd: ./Addresses
|
| gender | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idPractitioner.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
RequirementsNeeded to address the person correctly.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typecode BindingThe gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: STF-5
- rim: ./administrativeGender
- servd: ./GenderCode
|
| birthDate | Σ | 0..0 | date | There are no (further) constraints on this element Element idPractitioner.birthDate Short descriptionThe date on which the practitioner was born DefinitionThe date of birth for the practitioner.
RequirementsNeeded for identification.
Data typedate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: STF-6
- rim: ./birthTime
- servd: (not represented in ServD)
|
| photo | C | 0..0 | Attachment | There are no (further) constraints on this element Element idPractitioner.photo Short descriptionImage of the person DefinitionRequirementsMany EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
CommentsWhen providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
Data typeAttachment ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - att-1: If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists() Mappings- rim: n/a
- v2: ED/RP
- rim: ED
- rim: ./subjectOf/ObservationEvent[code="photo"]/value
- servd: ./ImageURI (only supports the URI reference)
|
| qualification | | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualification Short descriptionCertification, licenses, or training pertaining to the provision of care DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CER?
- rim: .playingEntity.playingRole[classCode=QUAL].code
- servd: ./Qualifications
|
| communication | | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.communication Short descriptionA language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication.
RequirementsKnowing which language a practitioner speaks can help in facilitating communication with patients.
CommentsThe structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Data typeCodeableConcept BindingA human language. CommonLanguages (preferred) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PID-15, NK1-20, LAN-2
- rim: ./languageCommunication
- servd: ./Languages.LanguageSpokenCode
|