Vermittlungscode (Identifier)

Fachlicher Kontext

Scope Art
Vermittlungscode anfordern Ausgabeparameter
alle anderen Operationen Eingabeparameter

Wie auf der Seite Vermittlungscode erläutert, enthält das hier beschriebene Identifier-Profil ausschließlich die 12-stellige alphanumerische Zeichenfolge als Business-Identifier für Vermittlungen. (Weitere Informationen und den Unterschied zum ServiceRequest-Profil sind ebenfalls auf der Seite Vermittlungscode zu finden.)


Für die Operation zum Anfordern eines Vermittlungscodes ist dies der einzige Ausgabeparameter. Grund dafür ist, dass an dieser Stelle die Zeichenfolge das einzig relevante und neue (das heißt, zuvor unbekannte) Datum für KVen ist:

  • Die Dringlichkeit ist zu diesem Zeitpunkt immer urgent.

  • Der Status ist zu diesem Zeitpunkt immer draft.

  • Die verknüpften Leistungsmerkmale sind als Eingabeparameter übergeben worden und daher der KV bereits bekannt.

  • Der Zeitpunkt der letzten Statusänderung ist hier nicht relevant, sollte aber nicht wesentlich vom Zeitpunkt des Absendens des entsprechenden Requests abweichen. (Der Zeitpunkt entspricht in diesem Fall dem Zeitpunkt, an dem der Vermittlungscodes generiert wurde. Dies erfolgt direkt nach der Validierung des entsprechenden Requests.)


Ähnlich verhält es sich bei allen anderen Operationen: auch hier ist nur der Business-Identifier relevant, um eine Vermittlung eindeutig zu identifizieren. Daher wird auch nur die Identifier-Ressource (und nicht die umfangreichere ServiceRequest-Ressource) als Eingabeparameter verlangt, um Terminsuchen und -buchungen durchzuführen, Buchungen abzusagen, den Status eines Vermittlungscodes oder Informationen zu einer bestehenden Terminbuchung abzurufen.


FHIR-Profil

Name KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode
Type Identifier
Base Definition http://hl7.org/fhir/StructureDefinition/Identifier (Version: R4)
Canonical URL https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode
Beschreibung

Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen.


id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
Identifier
ShortVermittlungscode zu einer Überweisung
Definition

Der Vermittlungscode ist ein eindeutiges Identifikationskennzeichen einer Vermittlung im Kontext des 116117 Terminservices und besteht aus 12 alphanumerischen Zeichen.

Cardinality0..*
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
Identifier.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Identifier.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Identifier.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Identifier.type
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Identifier.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Identifier.value
ShortVermittlungscode des Patienten
Definition

Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • pattern: Ein Vermittlungscode muss aus exakt 12 alphanumerischen Zeichen bestehen, mit Ausnahme von O, 0, E, 3, I, 1.
    matches('^[A-DF-HJ-NP-Za-df-hj-np-z24-9]{12}$')
Maximum string length12
ExamplesGeneral
123456
Vermittlungscode
XN6PF4UPZ5KX
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Identifier.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="KBV-PR-KV-DIGITAL-TS-KVEN-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_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode" />
<version value="0.1.0" />
<name value="KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode" />
<title value="KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode" />
<status value="draft" />
<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." />
<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." />
</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 des Patienten" />
<definition value="Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen." />
<min value="1" />
<example>
<label value="Vermittlungscode" />
<valueString value="XN6PF4UPZ5KX" />
</example>
<maxLength value="12" />
<constraint>
<key value="pattern" />
<severity value="error" />
<human value="Ein Vermittlungscode muss aus exakt 12 alphanumerischen Zeichen bestehen, mit Ausnahme von O, 0, E, 3, I, 1." />
<expression value="matches('^[A-DF-HJ-NP-Za-df-hj-np-z24-9]{12}$')" />
</constraint>
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "KBV-PR-KV-DIGITAL-TS-KVEN-Identifier-Vermittlungscode",
"text": {
"status": "generated",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode",
"version": "0.1.0",
"name": "KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode",
"title": "KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode",
"status": "draft",
"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.",
"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."
},
{
"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 des Patienten",
"definition": "Der Vermittlungscode ist eine 12-stellige, alphanumerische Folge von Zeichen.",
"min": 1,
"example": [
{
"label": "Vermittlungscode",
"valueString": "XN6PF4UPZ5KX"
}
],
"maxLength": 12,
"constraint": [
{
"key": "pattern",
"severity": "error",
"human": "Ein Vermittlungscode muss aus exakt 12 alphanumerischen Zeichen bestehen, mit Ausnahme von O, 0, E, 3, I, 1.",
"expression": "matches('^[A-DF-HJ-NP-Za-df-hj-np-z24-9]{12}$')"
}
],
"mustSupport": true
}
]
}
}
KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode

Anmerkungen

In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Elementen.

Element Anmerkung
Identifier.value Der Vermittlungscode besteht aus exakt 12 zufälligen alphanumerischen Zeichen. Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: O 0 I 1 E 3

Folgende (mit einem Must-Support-Flag gekennzeichnete) Elemente werden von den Systemen des 116117 Terminservices gespeichert, verarbeitet und zurückgegeben:

  • system

  • value


Terminology Bindings

Es sind KEINE Terminologien abweichend vom Basisprofil definiert.


Beispiele

Alle Beispiele sind hier im vorliegenden Projekt zu finden.


<Identifier xmlns="http://hl7.org/fhir" id="bbce5e04-99c1-4bbb-9a78-8ff904ed426f">
<system value="https://fhir.kbv.de/NamingSystem/KBV_NS_116117_TERMINSERVICE_Vermittlungscode" />
<value value="XN6PF4UPZ5KX" />
</Identifier>