Profil: Vermittlungscode (Identifier)
Fachlicher Kontext
Fordert eine Praxis / medizinische Einrichtung über das Praxisverwaltungssystem einen Vermittlungscode für eine Überweisung (Muster 6) oder ein PTV11 an, so wird die vorliegende Ressource zurückgegeben.
Diese enthält die 12-stellige alphanumerische Zeichenfolge, die als Business-Identifier für Vermittlungen dient und auf die Überweisung (Muster 6) oder das PTV11 aufgebracht werden soll.
FHIR-Profil
Name | KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode |
---|---|
Type | Identifier |
Base Definition | http://hl7.org/fhir/StructureDefinition/Identifier (Version: R4) |
Canonical URL | https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode |
KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode (Identifier) | Identifier | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..0 | CodeableConceptBinding |
system | S Σ | 1..1 | uriFixed Value |
value | S Σ I | 1..1 | string |
period | Σ | 0..0 | Period |
assigner | Σ | 0..0 | Reference(Organization) |
Identifier | |
Definition | Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt sind (Bsp.: XN6P-F4HP-Z5KX). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Identifier.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...0 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Identifier.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Identifier.type.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Identifier.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Identifier.type.coding.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The 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. |
Invariants |
|
Mappings |
|
Identifier.type.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where 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. |
Invariants |
|
Mappings |
|
Identifier.type.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
Summary | True |
Requirements | This 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. |
Comments | Amongst 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. |
Invariants |
|
Mappings |
|
Identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Fixed Value | https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode |
Mappings |
|
Identifier.value | |
Definition | Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt wird (Bsp.: XN6P-F4HP-Z5KX). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 Vermittlungscode XN6P-F4HP-Z5KX |
Mappings |
|
Identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...0 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...0 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="KBV-PR-116117-TERMINSERVICE-VCA-Identifier-Vermittlungscode" /> <text> <status value="generated" /> --- We have skipped the narrative for better readability of the resource --- </text> <url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode" /> <version value="1.0.0" /> <name value="KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode" /> <title value="KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode" /> <status value="active" /> <publisher value="kv.digital GmbH" /> <contact> <name value="kv.digital GmbH" /> <telecom> <system value="url" /> <value value="https://www.kv.digital" /> </telecom> </contact> <description value="Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt sind." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <type value="Identifier" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier" /> <derivation value="constraint" /> <differential> <element id="Identifier"> <path value="Identifier" /> <short value="Vermittlungscode zu einer Überweisung" /> <definition value="Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt sind (Bsp.: XN6P-F4HP-Z5KX)." /> </element> <element id="Identifier.use"> <path value="Identifier.use" /> <max value="0" /> </element> <element id="Identifier.type"> <path value="Identifier.type" /> <max value="0" /> <mustSupport value="false" /> </element> <element id="Identifier.type.coding"> <path value="Identifier.type.coding" /> <max value="1" /> <mustSupport value="false" /> </element> <element id="Identifier.type.coding.system"> <path value="Identifier.type.coding.system" /> <min value="1" /> <mustSupport value="false" /> </element> <element id="Identifier.type.coding.code"> <path value="Identifier.type.coding.code" /> <min value="1" /> <mustSupport value="false" /> </element> <element id="Identifier.type.coding.display"> <path value="Identifier.type.coding.display" /> <min value="1" /> <mustSupport value="false" /> </element> <element id="Identifier.type.coding.userSelected"> <path value="Identifier.type.coding.userSelected" /> <max value="0" /> </element> <element id="Identifier.system"> <path value="Identifier.system" /> <min value="1" /> <fixedUri value="https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode" /> <mustSupport value="true" /> </element> <element id="Identifier.value"> <path value="Identifier.value" /> <short value="Vermittlungscode" /> <definition value="Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt wird (Bsp.: XN6P-F4HP-Z5KX)." /> <min value="1" /> <example> <label value="Vermittlungscode" /> <valueString value="XN6P-F4HP-Z5KX" /> </example> <maxLength value="14" /> <constraint> <key value="pattern" /> <severity value="error" /> <human value="Ein Vermittlungscode muss aus 12 alphanumerischen Zeichen (Ausnahmen: O, 0, E, 3, I, 1) bestehen und je einen Bindestrich an der 4. und 8. Stelle enthalten." /> <expression value="matches('^[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}-[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}-[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}$')" /> </constraint> <mustSupport value="true" /> </element> <element id="Identifier.period"> <path value="Identifier.period" /> <max value="0" /> </element> <element id="Identifier.assigner"> <path value="Identifier.assigner" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "KBV-PR-116117-TERMINSERVICE-VCA-Identifier-Vermittlungscode", "text": { "status": "generated", --- We have skipped the narrative for better readability of the resource --- }, "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode", "version": "1.0.0", "name": "KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode", "title": "KBV_PR_116117_TERMINSERVICE_VCA_Identifier_Vermittlungscode", "status": "active", "publisher": "kv.digital GmbH", "contact": [ { "name": "kv.digital GmbH", "telecom": [ { "system": "url", "value": "https://www.kv.digital" } ] } ], "description": "Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt sind.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "type": "Identifier", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier", "derivation": "constraint", "differential": { "element": [ { "id": "Identifier", "path": "Identifier", "short": "Vermittlungscode zu einer Überweisung", "definition": "Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt sind (Bsp.: XN6P-F4HP-Z5KX)." }, { "id": "Identifier.use", "path": "Identifier.use", "max": "0" }, { "id": "Identifier.type", "path": "Identifier.type", "max": "0", "mustSupport": false }, { "id": "Identifier.type.coding", "path": "Identifier.type.coding", "max": "1", "mustSupport": false }, { "id": "Identifier.type.coding.system", "path": "Identifier.type.coding.system", "min": 1, "mustSupport": false }, { "id": "Identifier.type.coding.code", "path": "Identifier.type.coding.code", "min": 1, "mustSupport": false }, { "id": "Identifier.type.coding.display", "path": "Identifier.type.coding.display", "min": 1, "mustSupport": false }, { "id": "Identifier.type.coding.userSelected", "path": "Identifier.type.coding.userSelected", "max": "0" }, { "id": "Identifier.system", "path": "Identifier.system", "min": 1, "fixedUri": "https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode", "mustSupport": true }, { "id": "Identifier.value", "path": "Identifier.value", "short": "Vermittlungscode", "definition": "Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen, welche zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt wird (Bsp.: XN6P-F4HP-Z5KX).", "min": 1, "example": [ { "label": "Vermittlungscode", "valueString": "XN6P-F4HP-Z5KX" } ], "maxLength": 14, "constraint": [ { "key": "pattern", "severity": "error", "human": "Ein Vermittlungscode muss aus 12 alphanumerischen Zeichen (Ausnahmen: O, 0, E, 3, I, 1) bestehen und je einen Bindestrich an der 4. und 8. Stelle enthalten.", "expression": "matches('^[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}-[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}-[A-DF-HJ-NP-Za-df-hj-np-z24-9]{4}$')" } ], "mustSupport": true }, { "id": "Identifier.period", "path": "Identifier.period", "max": "0" }, { "id": "Identifier.assigner", "path": "Identifier.assigner", "max": "0" } ] } }
Anmerkungen
In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.
Feld | Anmerkung |
---|---|
Identifier.value |
Der Vermittlungscode besteht aus 12 zufälligen alphanumerischen Zeichen, die zur besseren Lesbarkeit an der 4. und 8. Stelle mit einem Bindestrich getrennt werden (Bsp.: XN6P-F4HP-Z5KX). Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: O 0 I 1 E 3 |
Beispiele
Alle Beispiele sind hier im vorliegenden Projekt zu finden.
<Identifier xmlns="http://hl7.org/fhir" id="bbce5e04-99c1-4bbb-9a78-8ff904ed426z"> <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode" /> <value value="XN6P-F4UF-Z5KX" /> </Identifier>