OrganizationDirectory
Das OrganizationDirectory
-Profil beschreibt Leistungserbingerinstitutionen (LEI), die Gesundheitsdienstleistungen anbieten oder verwalten. Zur Beschreibung gehören Informationen zur Identität der Organisation, ihre Kontaktdaten, Adresse und die verschiedenen Rollen oder Funktionen, die sie innerhalb des Gesundheitssystems erfüllt. Dies kann Krankenhäuser, Kliniken, Apotheken, Pflegeeinrichtungen und andere Gesundheitseinrichtungen umfassen.
Ein wesentliches Merkmal dieser Ressource ist die TelematikID. Diese muss in der Ressource vorhanden sein, damit der Medication Service einen Deduplizierungsmechanismus durchführen kann. Die TelematikID ermöglicht eine eindeutige Identifizierung und Vermeidung von Duplikaten innerhalb des Systems, was zur Effizienz und Genauigkeit der Gesundheitsdienstleistungen beiträgt. Der Medication Service verwendet dazu das FHIR-Profil des FHIR-Verzeichnisdienstes.
Profil für gemeinsame Datengrundlage im ePA Medication Service
Organization in gematik Directory
OrganizationDirectory (Organization) | I | Organization | |
id | S Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | S Σ | 1..* | Coding |
Origin | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
organizationVisibility | S I | 0..* | Extension(Coding) |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ I | 1..* | Identifier |
TelematikID | S Σ I | 1..1 | IdentifierTelematikId |
BSNR | S Σ I | 0..1 | IdentifierBsnr |
KZVA | S Σ I | 0..1 | IdentifierKzva |
IKNR | S Σ I | 0..1 | IdentifierIknr |
active | S Σ ?! | 0..1 | boolean |
type | S Σ | 1..* | CodeableConcept |
providerType | S Σ | 0..* | CodeableConceptBinding |
profession | S Σ | 0..* | CodeableConceptBinding |
name | S Σ I | 1..1 | string |
alias | S | 0..* | string |
telecom | I | 0..* | ContactPoint |
address | S I | 0..* | Address |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | S Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | S Σ | 0..1 | string |
line | S Σ | 0..* | string |
city | S Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | S Σ | 0..1 | string |
postalCode | S Σ | 0..1 | string |
country | S Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
partOf | S Σ I | 0..1 | Reference(Organization) |
contact | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | I | 0..* | ContactPoint |
address | 0..1 | Address | |
endpoint | I | 0..* | Reference(Endpoint) |
Organization | |
Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
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 |
Must Support | True |
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.meta.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.meta.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.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Mappings |
|
Organization.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
Mappings |
|
Organization.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Mappings |
|
Organization.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Mappings |
|
Organization.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
Organization.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 1...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Must Support | True |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
Organization.meta.tag:Origin | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 1...1 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Must Support | True |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
Organization.meta.tag:Origin.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.meta.tag:Origin.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.meta.tag:Origin.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 | https://gematik.de/fhir/directory/CodeSystem/Origin |
Mappings |
|
Organization.meta.tag:Origin.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.meta.tag:Origin.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 | 0...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 |
|
Mappings |
|
Organization.meta.tag:Origin.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 |
|
Mappings |
|
Organization.meta.tag:Origin.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.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:organizationVisibility | |
Definition | Visibility of an Organization in the FHIR-VZD. This Extensions includes codes of use-cases im which this Organization SHALL not be visible. |
Cardinality | 0...* |
Type | Extension(Coding) |
Must Support | True |
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 | 1...* |
Type | Identifier |
Must Support | True |
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 system(Value) |
Invariants |
|
Mappings |
|
Organization.identifier:TelematikID | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierTelematikId |
Must Support | True |
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:BSNR | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierBsnr |
Must Support | True |
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:KZVA | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierKzva |
Must Support | True |
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:IKNR | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierIknr |
Must Support | True |
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.active | |
Definition | Whether the organization's record is still in active use. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
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 | 1...* |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Must Support | True |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Organization.type:providerType | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Must Support | True |
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.type:profession | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Must Support | True |
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 |
Must Support | True |
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 | A contact detail for the organization. |
Cardinality | 0...* |
Type | 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. |
Invariants |
|
Mappings |
|
Organization.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.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.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Must Support | True |
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.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.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 |
Must Support | True |
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.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 |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Organization.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Organization.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.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 |
Must Support | True |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Organization.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Organization.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Organization.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.partOf | |
Definition | The organization of which this organization forms a part. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
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 | 0...* |
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 | 0...* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
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.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="OrganizationDirectory" /> <url value="https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory" /> <version value="0.11.12" /> <name value="OrganizationDirectory" /> <title value="Organization in gematik Directory" /> <status value="active" /> <publisher value="gematik GmbH" /> <description value="Defines the data structure for medical, regulatory and technical \norganisations specific for german Healthcare and Telematics Infrastructure." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Organization" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" /> <derivation value="constraint" /> <differential> <element id="Organization.id"> <path value="Organization.id" /> <mustSupport value="true" /> </element> <element id="Organization.meta.tag"> <path value="Organization.meta.tag" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.meta.tag:Origin"> <path value="Organization.meta.tag" /> <sliceName value="Origin" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/directory/ValueSet/OriginVS" /> </binding> </element> <element id="Organization.meta.tag:Origin.system"> <path value="Organization.meta.tag.system" /> <min value="1" /> <patternUri value="https://gematik.de/fhir/directory/CodeSystem/Origin" /> </element> <element id="Organization.extension:organizationVisibility"> <path value="Organization.extension" /> <sliceName value="organizationVisibility" /> <min value="0" /> <max value="*" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/directory/StructureDefinition/OrganizationVisibility" /> </type> <mustSupport value="true" /> </element> <element id="Organization.identifier"> <path value="Organization.identifier" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.identifier:TelematikID"> <path value="Organization.identifier" /> <sliceName value="TelematikID" /> <min value="1" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" /> </type> <mustSupport value="true" /> </element> <element id="Organization.identifier:BSNR"> <path value="Organization.identifier" /> <sliceName value="BSNR" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-bsnr" /> </type> <mustSupport value="true" /> </element> <element id="Organization.identifier:KZVA"> <path value="Organization.identifier" /> <sliceName value="KZVA" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-kzva" /> </type> <mustSupport value="true" /> </element> <element id="Organization.identifier:IKNR"> <path value="Organization.identifier" /> <sliceName value="IKNR" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-iknr" /> </type> <mustSupport value="true" /> </element> <element id="Organization.active"> <path value="Organization.active" /> <mustSupport value="true" /> </element> <element id="Organization.type"> <path value="Organization.type" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.type:providerType"> <path value="Organization.type" /> <sliceName value="providerType" /> <min value="0" /> <max value="*" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/directory/ValueSet/OrganizationTypeVS" /> </binding> </element> <element id="Organization.type:profession"> <path value="Organization.type" /> <sliceName value="profession" /> <min value="0" /> <max value="*" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/directory/ValueSet/OrganizationProfessionOIDTypeVS" /> </binding> </element> <element id="Organization.name"> <path value="Organization.name" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Organization.alias"> <path value="Organization.alias" /> <mustSupport value="true" /> </element> <element id="Organization.address"> <path value="Organization.address" /> <mustSupport value="true" /> </element> <element id="Organization.address.use"> <path value="Organization.address.use" /> <mustSupport value="true" /> </element> <element id="Organization.address.text"> <path value="Organization.address.text" /> <mustSupport value="true" /> </element> <element id="Organization.address.line"> <path value="Organization.address.line" /> <mustSupport value="true" /> </element> <element id="Organization.address.city"> <path value="Organization.address.city" /> <mustSupport value="true" /> </element> <element id="Organization.address.state"> <path value="Organization.address.state" /> <mustSupport value="true" /> </element> <element id="Organization.address.postalCode"> <path value="Organization.address.postalCode" /> <mustSupport value="true" /> </element> <element id="Organization.address.country"> <path value="Organization.address.country" /> <mustSupport value="true" /> </element> <element id="Organization.partOf"> <path value="Organization.partOf" /> <mustSupport value="true" /> </element> <element id="Organization.contact"> <path value="Organization.contact" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "OrganizationDirectory", "url": "https://gematik.de/fhir/directory/StructureDefinition/OrganizationDirectory", "version": "0.11.12", "name": "OrganizationDirectory", "title": "Organization in gematik Directory", "status": "active", "publisher": "gematik GmbH", "description": "Defines the data structure for medical, regulatory and technical \norganisations specific for german Healthcare and Telematics Infrastructure.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Organization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization", "derivation": "constraint", "differential": { "element": [ { "id": "Organization.id", "path": "Organization.id", "mustSupport": true }, { "id": "Organization.meta.tag", "path": "Organization.meta.tag", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Organization.meta.tag:Origin", "path": "Organization.meta.tag", "sliceName": "Origin", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/directory/ValueSet/OriginVS" } }, { "id": "Organization.meta.tag:Origin.system", "path": "Organization.meta.tag.system", "min": 1, "patternUri": "https://gematik.de/fhir/directory/CodeSystem/Origin" }, { "id": "Organization.extension:organizationVisibility", "path": "Organization.extension", "sliceName": "organizationVisibility", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/directory/StructureDefinition/OrganizationVisibility" ] } ], "mustSupport": true }, { "id": "Organization.identifier", "path": "Organization.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Organization.identifier:TelematikID", "path": "Organization.identifier", "sliceName": "TelematikID", "min": 1, "max": "1", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ], "mustSupport": true }, { "id": "Organization.identifier:BSNR", "path": "Organization.identifier", "sliceName": "BSNR", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-bsnr" ] } ], "mustSupport": true }, { "id": "Organization.identifier:KZVA", "path": "Organization.identifier", "sliceName": "KZVA", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kzva" ] } ], "mustSupport": true }, { "id": "Organization.identifier:IKNR", "path": "Organization.identifier", "sliceName": "IKNR", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-iknr" ] } ], "mustSupport": true }, { "id": "Organization.active", "path": "Organization.active", "mustSupport": true }, { "id": "Organization.type", "path": "Organization.type", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Organization.type:providerType", "path": "Organization.type", "sliceName": "providerType", "min": 0, "max": "*", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/directory/ValueSet/OrganizationTypeVS" } }, { "id": "Organization.type:profession", "path": "Organization.type", "sliceName": "profession", "min": 0, "max": "*", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/directory/ValueSet/OrganizationProfessionOIDTypeVS" } }, { "id": "Organization.name", "path": "Organization.name", "min": 1, "mustSupport": true }, { "id": "Organization.alias", "path": "Organization.alias", "mustSupport": true }, { "id": "Organization.address", "path": "Organization.address", "mustSupport": true }, { "id": "Organization.address.use", "path": "Organization.address.use", "mustSupport": true }, { "id": "Organization.address.text", "path": "Organization.address.text", "mustSupport": true }, { "id": "Organization.address.line", "path": "Organization.address.line", "mustSupport": true }, { "id": "Organization.address.city", "path": "Organization.address.city", "mustSupport": true }, { "id": "Organization.address.state", "path": "Organization.address.state", "mustSupport": true }, { "id": "Organization.address.postalCode", "path": "Organization.address.postalCode", "mustSupport": true }, { "id": "Organization.address.country", "path": "Organization.address.country", "mustSupport": true }, { "id": "Organization.partOf", "path": "Organization.partOf", "mustSupport": true }, { "id": "Organization.contact", "path": "Organization.contact", "mustSupport": true } ] } }