ERP ServiceRequest Organization
Übersicht über das Profil
Name | Description | Canonical_URL | Status | Version | Basiert auf |
---|---|---|---|---|---|
ERPServiceRequestOrganization | Organization that can be used to specify a KIM address | https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization | draft | 1.2 | https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Organization |
Über das Profil
Motivation
Zur Angabe einer Einrichtung ist es je nach Anwendungsfall notwendig die KIM-Adresse mit anzugeben. Dafür wurde dieses Profil spezifiziert, um Organisationen mit KIM, bzw. TIM-Adresse anzugeben. Weiterhin enthält das Profil die Möglichkeit eine Adresse anzugeben und einen verpflichtenden Namen. Dieser dient insbesondere den Nutzern zur Darstellung mit welcher Einrichtung die Kommunikation geführt wird.
Inhalt des Profils
Folgende Ansichten existieren auf das Profil:
ERPServiceRequestOrganization (Organization) | I | KBV_PR_Base_Organization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
ergaenzende_Angaben | I | 0..1 | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ I | 0..* | Identifier |
Institutionskennzeichen | Σ I | 0..* | IdentifierIknr |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBindingFixed Value |
type | Σ | 1..1 | CodeableConceptBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codePattern |
display | Σ | 0..1 | stringPattern |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uriFixed Value |
value | Σ I | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
Betriebsstaettennummer | Σ I | 0..* | IdentifierBsnr |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBindingFixed Value |
type | Σ | 1..1 | CodeableConceptBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codePattern |
display | Σ | 0..1 | stringPattern |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uriFixed Value |
value | Σ I | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ I | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
display | Σ | 1..1 | string |
VKNR | Σ I | 0..* | IdentifierVknr |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBindingFixed Value |
type | Σ | 1..1 | CodeableConceptBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codePattern |
display | Σ | 0..1 | stringPattern |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
display | Σ | 1..1 | string |
KZV-Abrechnungsnummer | Σ I | 0..1 | IdentifierKzva |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBindingFixed Value |
type | Σ | 1..1 | CodeableConceptBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codePattern |
display | Σ | 0..1 | stringPattern |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uriFixed Value |
value | Σ I | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
display | Σ | 1..1 | string |
Telematik-ID | Σ I | 0..* | IdentifierTelematikId |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 1..1 | CodeableConceptBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codePattern |
display | Σ | 0..1 | stringPattern |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
active | Σ ?! | 0..1 | boolean |
type | Σ | 0..* | CodeableConcept |
name | S Σ I | 1..1 | string |
alias | 0..* | string | |
telecom | I | 0..* | KBV_PR_Base_Datatype_Contactpoint |
address | S I | 0..* | Address |
Strassenanschrift | I | 0..* | KBV_PR_Base_Datatype_Street_Address |
Postfach | I | 0..* | KBV_PR_Base_Datatype_Post_Office_Box |
partOf | Σ I | 0..1 | Reference(Organization) |
contact | S | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | S I | 1..* | ContactPoint |
tel | S I | 1..1 | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ I | 1..1 | codeBindingPattern |
value | S Σ | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ I | 0..1 | Period |
kim | S I | 0..1 | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ I | 1..1 | codeBindingPattern |
value | S Σ | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ I | 0..1 | Period |
address | 0..1 | Address | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | stringBinding |
period | Σ I | 0..1 | Period |
endpoint | I | 0..* | Reference(Endpoint) |
Organization | |
Definition | Die Einrichtung beschreibt beispielsweise den Ort, an dem ein Kontakt zwischen der zu behandelnden Person und der leistungserbringenden Person stattfindet (z.B. Praxis). Diese kann aber auch eine rein 'fiktive' Organisation zur Abrechnung sein (z.B. IK-Organisation für Hebammen). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Organization.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Organization.meta | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Organization.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting 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. |
Invariants |
|
Mappings |
|
Organization.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language 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). |
Invariants |
|
Mappings |
|
Organization.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained 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. |
Invariants |
|
Mappings |
|
Organization.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This 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. |
Mappings |
|
Organization.extension | |
Definition | May 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. |
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 |
|
Organization.extension:ergaenzende_Angaben | |
Definition | Mit diesem Profil ist eine zusätzlicher Kommentar/Information definiert worden. Dieser kann an diverse Ressourcen hinzugefügt werden. Der Informationsgehalt der beinhaltenden Ressource darf nicht grundlegend verändert oder negiert werden. |
Cardinality | 0...1 |
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. |
Invariants |
|
Mappings |
|
Organization.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier 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. |
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 |
|
Organization.identifier | |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Slicing | Unordered, Open, by type(Pattern) |
Invariants |
|
Mappings |
|
Organization.identifier:Institutionskennzeichen | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Type | IdentifierIknr |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Fixed Value | official |
Mappings |
|
Organization.identifier:Institutionskennzeichen.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
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 |
|
Pattern | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] } |
Mappings |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...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 |
|
Pattern | { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } |
Mappings |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Pattern | http://terminology.hl7.org/CodeSystem/v2-0203 |
Mappings |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | XX |
Mappings |
|
Organization.identifier:Institutionskennzeichen.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | Organisations-ID |
Mappings |
|
Organization.identifier:Institutionskennzeichen.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...1 |
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 |
|
Organization.identifier:Institutionskennzeichen.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 |
|
Organization.identifier:Institutionskennzeichen.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 |
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 | http://fhir.de/sid/arge-ik/iknr |
Mappings |
|
Organization.identifier:Institutionskennzeichen.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:Institutionskennzeichen.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:Institutionskennzeichen.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Type | IdentifierBsnr |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Fixed Value | official |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
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 |
|
Pattern | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "BSNR" } ] } |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...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 |
|
Pattern | { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "BSNR" } |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Pattern | http://terminology.hl7.org/CodeSystem/v2-0203 |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | BSNR |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | Primary physician office number |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.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...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
|
Organization.identifier:Betriebsstaettennummer.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 |
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_Base_BSNR |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.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...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.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 |
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 | http://fhir.de/sid/arge-ik/iknr |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:Betriebsstaettennummer.assigner.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:Betriebsstaettennummer.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Type | IdentifierVknr |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Fixed Value | official |
Mappings |
|
Organization.identifier:VKNR.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
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 |
|
Pattern | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NIIP" } ] } |
Mappings |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...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 |
|
Pattern | { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NIIP" } |
Mappings |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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 |
|
Pattern | http://terminology.hl7.org/CodeSystem/v2-0203 |
Mappings |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | NIIP |
Mappings |
|
Organization.identifier:VKNR.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | National Insurance Payor Identifier (Payor) |
Mappings |
|
Organization.identifier:VKNR.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...1 |
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 |
|
Organization.identifier:VKNR.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 |
|
Organization.identifier:VKNR.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 |
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 | http://fhir.de/sid/kbv/vknr |
Mappings |
|
Organization.identifier:VKNR.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:VKNR.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:VKNR.assigner.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 |
|
Organization.identifier:VKNR.assigner.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 |
|
Organization.identifier:VKNR.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.assigner.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.assigner.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.assigner.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 |
|
Organization.identifier:VKNR.assigner.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 |
|
Organization.identifier:VKNR.assigner.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:VKNR.assigner.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...1 |
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 |
|
Organization.identifier:VKNR.assigner.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 |
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 | http://fhir.de/sid/arge-ik/iknr |
Mappings |
|
Organization.identifier:VKNR.assigner.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:VKNR.assigner.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:VKNR.assigner.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:VKNR.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierKzva |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Fixed Value | official |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
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 |
|
Pattern | { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "KZVA" } ] } |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...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 |
|
Pattern | { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "KZVA" } |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Pattern | http://fhir.de/CodeSystem/identifier-type-de-basis |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | KZVA |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | KZVAbrechnungsnummer |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.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...1 |
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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.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 |
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 | http://fhir.de/sid/kzbv/kzvabrechnungsnummer |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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...1 |
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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.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 |
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 | http://fhir.de/sid/arge-ik/iknr |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:KZV-Abrechnungsnummer.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Organization.identifier:Telematik-ID | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Type | IdentifierTelematikId |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
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 |
|
Organization.identifier:Telematik-ID.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
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 |
|
Pattern | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } ] } |
Mappings |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...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 |
|
Pattern | { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } |
Mappings |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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 |
|
Pattern | http://terminology.hl7.org/CodeSystem/v2-0203 |
Mappings |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | PRN |
Mappings |
|
Organization.identifier:Telematik-ID.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | Provider number |
Mappings |
|
Organization.identifier:Telematik-ID.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...1 |
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 |
|
Organization.identifier:Telematik-ID.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 |
|
Organization.identifier:Telematik-ID.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 |
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://gematik.de/fhir/sid/telematik-id |
Mappings |
|
Organization.identifier:Telematik-ID.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Mappings |
|
Organization.identifier:Telematik-ID.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.identifier:Telematik-ID.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
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 |
|
Organization.active | |
Definition | Whether the organization's record is still in active use. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
Organization.type | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Summary | True |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Invariants |
|
Mappings |
|
Organization.name | |
Definition | A name associated with the organization. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to use the name as the label of the organization. |
Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
Invariants |
|
Mappings |
|
Organization.alias | |
Definition | A list of alternate names that the organization is known as, or was known as in the past. |
Cardinality | 0...* |
Type | string |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
Invariants |
|
Mappings |
|
Organization.telecom | |
Definition | Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten. |
Cardinality | 0...* |
Type | KBV_PR_Base_Datatype_Contactpoint |
Requirements | Human contact for the organization. |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Invariants |
|
Mappings |
|
Organization.address | |
Definition | An address for the organization. |
Cardinality | 0...* |
Type | Address |
Must Support | True |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. |
Slicing | Unordered, Open, by type(Value) |
Invariants |
|
Mappings |
|
Organization.address:Strassenanschrift | |
Definition | Hier können Angaben zur Straßenanschrift gemacht werden. |
Cardinality | 0...* |
Type | KBV_PR_Base_Datatype_Street_Address |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | Beispiel für einfache Adresse { "use": "home", "type": "postal", "line": [ "Musterweg 42" ], "city": "Musterhausen", "postalCode": "99999" } |
Mappings |
|
Organization.address:Postfach | |
Definition | Hier können Angaben zu einem Postfach gemacht werden. |
Cardinality | 0...* |
Type | KBV_PR_Base_Datatype_Post_Office_Box |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | Beispiel für einfache Adresse { "use": "home", "type": "postal", "line": [ "Musterweg 42" ], "city": "Musterhausen", "postalCode": "99999" } |
Mappings |
|
Organization.partOf | |
Definition | The organization of which this organization forms a part. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Requirements | Need to be able to track the hierarchy of organizations within an organization. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Organization.contact | |
Definition | Contact for the organization for a certain purpose. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Requirements | Need to keep track of assigned contact points within bigger organization. |
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. |
Invariants |
|
Mappings |
|
Organization.contact.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 |
|
Organization.contact.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 |
|
Organization.contact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier 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. |
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. |
Invariants |
|
Mappings |
|
Organization.contact.purpose | |
Definition | Indicates a purpose for which the contact can be reached. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The purpose for which you would contact a contact party. |
Requirements | Need to distinguish between multiple contact persons. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Organization.contact.name | |
Definition | A name associated with the contact. |
Cardinality | 0...1 |
Type | HumanName |
Requirements | Need to be able to track the person by name. |
Comments | Names 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 might or might 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. |
Invariants |
|
Mappings |
|
Organization.contact.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Cardinality | 1...* |
Type | ContactPoint |
Must Support | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Slicing | Unordered, Open, by system(Pattern) |
Invariants |
|
Mappings |
|
Organization.contact.telecom:tel | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Cardinality | 1...1 |
Type | ContactPoint |
Must Support | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:tel.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 |
|
Organization.contact.telecom:tel.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 |
|
Organization.contact.telecom:tel.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 1...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | phone |
Mappings |
|
Organization.contact.telecom:tel.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:tel.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:tel.rank | |
Definition | Specifies 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. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:tel.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:kim | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Cardinality | 0...1 |
Type | ContactPoint |
Must Support | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:kim.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 |
|
Organization.contact.telecom:kim.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 |
|
Organization.contact.telecom:kim.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 1...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | |
Mappings |
|
Organization.contact.telecom:kim.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:kim.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:kim.rank | |
Definition | Specifies 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. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Organization.contact.telecom:kim.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A 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. |
Invariants |
|
Mappings |
|
Organization.contact.address | |
Definition | Visiting or postal addresses for the contact. |
Cardinality | 0...1 |
Type | Address |
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Mappings |
|
Organization.contact.address.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 |
|
Organization.contact.address.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 |
|
Organization.contact.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
Organization.contact.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
Organization.contact.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Organization.contact.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Organization.contact.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Organization.contact.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Organization.contact.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.contact.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Organization.contact.address.country | |
Definition | Staat gemäß dem ValueSet https://fhir.kbv.de/ValueSet/KBV_VS_Base_Deuev_Anlage_8 |
Cardinality | 0...1 |
Type | string |
Binding | KBV_VS_Base_Deuev_Anlage_8 (extensible) |
Summary | True |
Comments | Staat gemäß dem ValueSet https://fhir.kbv.de/ValueSet/KBV_VS_Base_Deuev_Anlage_8 |
Invariants |
|
Mappings |
|
Organization.contact.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | A 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. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Organization.endpoint | |
Definition | Technical endpoints providing access to services operated for the organization. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="erp-service-request-organization" /> <url value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization" /> <version value="1.2" /> <name value="ERPServiceRequestOrganization" /> <title value="ERP Service Request Organization" /> <status value="draft" /> <experimental value="false" /> <date value="2025-01-01" /> <publisher value="gematik GmbH" /> <description value="Organization that can be used to specify a KIM address" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Organization" /> <baseDefinition value="https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Organization" /> <derivation value="constraint" /> <differential> <element id="Organization.name"> <path value="Organization.name" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.address"> <path value="Organization.address" /> <mustSupport value="true" /> </element> <element id="Organization.contact"> <path value="Organization.contact" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom"> <path value="Organization.contact.telecom" /> <slicing> <discriminator> <type value="pattern" /> <path value="system" /> </discriminator> <description value="Slices on contact options" /> <ordered value="false" /> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom:tel"> <path value="Organization.contact.telecom" /> <sliceName value="tel" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom:tel.system"> <path value="Organization.contact.telecom.system" /> <min value="1" /> <patternCode value="phone" /> </element> <element id="Organization.contact.telecom:tel.value"> <path value="Organization.contact.telecom.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom:kim"> <path value="Organization.contact.telecom" /> <sliceName value="kim" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Organization.contact.telecom:kim.system"> <path value="Organization.contact.telecom.system" /> <min value="1" /> <patternCode value="email" /> </element> <element id="Organization.contact.telecom:kim.value"> <path value="Organization.contact.telecom.value" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "erp-service-request-organization", "url": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization", "version": "1.2", "name": "ERPServiceRequestOrganization", "title": "ERP Service Request Organization", "status": "draft", "experimental": false, "date": "2025-01-01", "publisher": "gematik GmbH", "description": "Organization that can be used to specify a KIM address", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Organization", "baseDefinition": "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Organization", "derivation": "constraint", "differential": { "element": [ { "id": "Organization.name", "path": "Organization.name", "min": 1, "mustSupport": true }, { "id": "Organization.address", "path": "Organization.address", "mustSupport": true }, { "id": "Organization.contact", "path": "Organization.contact", "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom", "path": "Organization.contact.telecom", "slicing": { "discriminator": [ { "type": "pattern", "path": "system" } ], "rules": "open", "description": "Slices on contact options", "ordered": false }, "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom:tel", "path": "Organization.contact.telecom", "sliceName": "tel", "min": 1, "max": "1", "mustSupport": true }, { "id": "Organization.contact.telecom:tel.system", "path": "Organization.contact.telecom.system", "min": 1, "patternCode": "phone" }, { "id": "Organization.contact.telecom:tel.value", "path": "Organization.contact.telecom.value", "min": 1, "mustSupport": true }, { "id": "Organization.contact.telecom:kim", "path": "Organization.contact.telecom", "sliceName": "kim", "min": 0, "max": "1", "mustSupport": true }, { "id": "Organization.contact.telecom:kim.system", "path": "Organization.contact.telecom.system", "min": 1, "patternCode": "email" }, { "id": "Organization.contact.telecom:kim.value", "path": "Organization.contact.telecom.value", "min": 1, "mustSupport": true } ] } }
Terminologie Bindings
Folgende Bindings sind für diese Ressource spezifiziert:
Constraints
Folgende Constraints sind für diese Ressource spezifiziert: