Freigeben über


Veterans Affairs Provider (Independent Publisher) (Vorschau)

Die Anbieterverzeichnis-API erleichtert die Entwicklung von Anwendungen, die Listen von VA-Anbietern abrufen, Details zu Anbieterstandorten, Spezialitäten, Bürostunden und Patientenakzeptanzstatus anbieten können. Er nutzt FHIR-Standards, um die Einhaltung der CMS-Anforderungen für öffentlich zugängliche API-Endpunkte sicherzustellen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Richard Wilson
URL https://www.richardawilson.com
Email richard.a.wilson@microsoft.com
Connectormetadaten
Herausgeber Richard Wilson
DaVinci PDEX Plan Net Implementierungshandbuch https://docs.microsoft.com/connectors/veteransaffairsprovi
Webseite https://developer.va.gov
Datenschutzrichtlinie https://www.va.gov/privacy/
Kategorien Personalabteilung

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
VA-API-Schlüssel securestring Der VA-API-Schlüssel für diese API Richtig
Umwelt Schnur Die zu verwendende VA-API-Umgebung (Produktion oder Sandbox) Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Auflisten von Praktikern

Ruft eine Liste von Praktikern basierend auf angegebenen Kriterien ab, einschließlich Bezeichnern, Namen und Datumsangaben der letzten Aktualisierung.

Auflisten von Rollen des Arztes

Ruft eine Liste der Praktikerrollen basierend auf bestimmten Kriterien ab, einschließlich Bezeichnern und Namen, die ihre Rollen und Zuständigkeiten widerspiegeln.

Erhalten Sie Einen Arzt anhand der ID

Ruft detaillierte Informationen zu einem bestimmten Arzt anhand ihrer eindeutigen ID ab, einschließlich Bezeichnern, Namen und Qualifikationen.

Organisation nach ID abrufen

Ruft detaillierte Informationen zu einer bestimmten Organisation anhand seiner ID ab, einschließlich Name, Standort und anderen relevanten Details.

Organisationen auflisten

Ruft eine Liste von Organisationen basierend auf angegebenen Kriterien ab, einschließlich ihrer Speicherorte, Namen und anderen identifizierenden Informationen.

Rolle des Arztes anhand der ID abrufen

Ruft detaillierte Informationen zu einer bestimmten Praxisrolle anhand seiner eindeutigen ID ab, einschließlich Rollenzuweisungen, Qualifikationen und Bezeichnern.

Speicherorte auflisten

Ruft eine Liste der Speicherorte basierend auf angegebenen Kriterien ab, einschließlich Anbieterstandorten, Spezialitäten und Bürostunden.

Standort nach ID abrufen

Ruft detaillierte Informationen zu einem bestimmten Standort anhand seiner ID ab, einschließlich Anbieterstandorten, Spezialitäten und Bürostunden.

Auflisten von Praktikern

Ruft eine Liste von Praktikern basierend auf angegebenen Kriterien ab, einschließlich Bezeichnern, Namen und Datumsangaben der letzten Aktualisierung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
_id string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Kennung
identifier string

Ein eindeutiger Bezeichner für einen Arzt innerhalb eines bestimmten Systems.

Familienname
family string

Der Familienname des Arztes.

Vorname
given string

Der Vorname des Arztes.

Name
name string

Der Angegebene oder Familienname des Arztes.

Zuletzt aktualisiert
_lastUpdated string

Das Datum, an dem die Aufzeichnung des Arztes zuletzt aktualisiert wurde.

Seite
page integer

Die Seitenzahl des Suchergebnisses.

Anzahl
_count integer

Die Anzahl der in einer einzelnen Seite zurückgegebenen Ressourcen bis zu maximal 100.

Gibt zurück

Ein Bündel von Ressourcen, die Informationen zu einem oder mehreren Praktikern enthalten.

Auflisten von Rollen des Arztes

Ruft eine Liste der Praktikerrollen basierend auf bestimmten Kriterien ab, einschließlich Bezeichnern und Namen, die ihre Rollen und Zuständigkeiten widerspiegeln.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
_id string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Bezeichner des Arztes
practitioner.identifier string

Ein eindeutiger Bezeichner für einen Arzt innerhalb eines bestimmten Systems.

Name des Arztes
practitioner.name string

Der Angegebene oder Familienname des Arztes.

Zuletzt aktualisiert
_lastUpdated string

Das Datum, an dem die Rolle des Arztes zuletzt aktualisiert wurde.

Seite
page integer

Die angeforderte Seitenzahl.

Anzahl
_count integer

Die Anzahl der in einer einzelnen Seite zurückgegebenen Ressourcen bis zu maximal 100.

Gibt zurück

Ein Bündel von Praktischen Rollenressourcen, die in der Regel verwendet werden, um einen vollständigen Satz von Suchergebnissen oder eine Teilmenge von Ressourcen in einer paginierten Liste bereitzustellen.

Erhalten Sie Einen Arzt anhand der ID

Ruft detaillierte Informationen zu einem bestimmten Arzt anhand ihrer eindeutigen ID ab, einschließlich Bezeichnern, Namen und Qualifikationen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Gibt zurück

Eine Person, die direkt oder indirekt an der Bereitstellung der Gesundheitsversorgung beteiligt ist.

Organisation nach ID abrufen

Ruft detaillierte Informationen zu einer bestimmten Organisation anhand seiner ID ab, einschließlich Name, Standort und anderen relevanten Details.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Gibt zurück

Stellt eine Gruppe von Personen dar, die durch einen gemeinsamen Zweck definiert werden, z. B. ein Krankenhaus, eine Abteilung, ein Team oder eine Versicherungsgesellschaft.

Organisationen auflisten

Ruft eine Liste von Organisationen basierend auf angegebenen Kriterien ab, einschließlich ihrer Speicherorte, Namen und anderen identifizierenden Informationen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
_id string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Kennung
identifier string

Der logische Bezeichner der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Adresse
address string

Gibt den physischen Standort der Organisation mithilfe von Postkonventionen an.

Stadt
address-city string

Gibt die Stadt an, in der sich die Organisation befindet.

Staat
address-state string

Gibt den Zustand an, in dem sich die Organisation befindet.

Postleitzahl
address-postalcode string

Gibt die Postleitzahl für die Region an, in der sich die Organisation befindet.

Name
name string

Gibt den Namen der Organisation an, wie sie von Menschen referenziert wird.

Zuletzt aktualisiert
_lastUpdated string

Das Datum, an dem der Organisationsdatensatz zuletzt aktualisiert wurde.

Seite
page integer

Die Seitenzahl des Suchergebnisses.

Anzahl
_count integer

Die Anzahl der in einer einzelnen Seite zurückgegebenen Ressourcen bis zu maximal 100.

Gibt zurück

Rolle des Arztes anhand der ID abrufen

Ruft detaillierte Informationen zu einer bestimmten Praxisrolle anhand seiner eindeutigen ID ab, einschließlich Rollenzuweisungen, Qualifikationen und Bezeichnern.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Die logische ID der Ressource, die nach der Zuordnung unverändert bleibt.

Gibt zurück

Definiert die Rolle eines Arztes innerhalb einer Organisation oder Praxis im Gesundheitswesen.

Speicherorte auflisten

Ruft eine Liste der Speicherorte basierend auf angegebenen Kriterien ab, einschließlich Anbieterstandorten, Spezialitäten und Bürostunden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
_id string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Kennung
identifier string

Der logische Bezeichner der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Adresse
address string

Gibt den physischen Speicherort des Datensatzes mithilfe von Postkonventionen an.

Adresse Ort
address-city string

Gibt die Stadt an, in der sich der Standort befindet.

Adressstatus
address-state string

Gibt den Zustand an, in dem sich der Speicherort befindet.

Adresse Postleitzahl
address-postalcode string

Gibt die Postleitzahl für die Region an, in der sich der Standort befindet.

Name
name string

Gibt den Namen des Orts an, auf den der Mensch verweist.

Zuletzt aktualisiert
_lastUpdated string

Das Datum, an dem der Speicherortdatensatz zuletzt aktualisiert wurde.

Seite
page integer

Die Seitenzahl des Suchergebnisses.

Anzahl
_count integer

Die Anzahl der in einer einzelnen Seite zurückgegebenen Ressourcen bis zu maximal 100.

Gibt zurück

Eine Sammlung von "Location"-Ressourcen, die als Ergebnis eines Such-/Abfragevorgangs zurückgegeben wurden.

Standort nach ID abrufen

Ruft detaillierte Informationen zu einem bestimmten Standort anhand seiner ID ab, einschließlich Anbieterstandorten, Spezialitäten und Bürostunden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Die logische ID der Ressource. Nachdem dieser Wert zugewiesen wurde, ändert sich dieser Wert nie.

Gibt zurück

Informationen zu physischen Standorten, an denen Dienste bereitgestellt werden, und Ressourcen befinden sich.

Body
Location

Definitionen

Adresse

Definiert einen physischen Speicherort anhand seiner Adresskomponenten.

Name Pfad Typ Beschreibung
Stadt
city string

Der Ortsname der Adresse.

Country
country string

Der Name des Landes der Adresse.

Bezirk
district string

Der Bezirk oder die Unterregion der Adresse, die an der weiteren Position hilft.

Extension
extension array of object

Die Erweiterung enthält zusätzliche Informationen zur Adresse.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für die Adresse.

Zeilen
line array of string

Die tatsächliche Adresszeile, die die physische Position beschreibt.

Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Postleitzahl
postalCode string

Die Postleitzahl der Adresse.

Staat
state string

Das Bundesland oder die Provinz der Adresse.

Text
text string

Eine Textdarstellung der Adresse.

Typ
type string

Der Adresstyp (Post, physisch oder beides).

Verwendung
use string

Die Verwendung der Adresse (Privat, Arbeit, Temp, alt, Abrechnung).

Attachment

Ein komplexer Typ, der Inhalte in digitaler Form enthält.

Name Pfad Typ Beschreibung
Inhaltstyp
contentType string

Der MIME-Typ des Inhalts.

Erstellung
creation string

Datum und Uhrzeit der Erstellung des Inhalts.

Daten
data string

Die tatsächlichen Daten des Inhalts, dargestellt als base64-Zeichenfolge.

Extension
extension array of object

Eine Erweiterung für zusätzliche strukturierte Daten.

items
extension object
Hash
hash string

Ein Hash der Daten (z. B. SHA-1, SHA-256 oder MD5) zur Integritätsüberprüfung.

Id
id string

Ein eindeutiger Bezeichner für die Anlage.

Language
language string

Die Sprache des Inhalts, dargestellt als BCP-47-Sprachtag.

Größe
size integer

Die Größe der Daten in Byte.

Title
title string

Eine Bezeichnung oder ein Titel für die Anlage.

URL
url string

Eine URL, über die auf die Daten zugegriffen werden kann.

Eine Verknüpfung im Zusammenhang mit einer Bündelressource.

Name Pfad Typ Beschreibung
Extension
extension array of object

Eine Erweiterung für zusätzliche strukturierte Daten.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für den Link.

Modifizierererweiterung
modifierExtension array of object

Eine Erweiterung, die andere Elemente ändert.

items
modifierExtension object
Beziehung
relation string

Der Typ der Beziehung zur verknüpften Ressource (z. B. next, previous, etc.).

URL
url string

Die URL, die auf das Ziel des Links verweist.

CodeableConcept

Ein Konzept, das durch einen formalen Verweis auf eine Terminologie oder Ontologie definiert werden kann oder von Text bereitgestellt werden kann.

Name Pfad Typ Beschreibung
Codieren
coding array of Coding

Eine Liste der Codierungen für das Konzept.

Extension
extension array of object

Eine Erweiterung für zusätzliche strukturierte Daten im Zusammenhang mit CodeableConcept.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für die CodeableConcept-Instanz.

Text
text string

Eine menschliche Sprachdarstellung des Konzepts, wie vom Benutzer, der die Daten eingegeben hat und/oder die die beabsichtigte Bedeutung des Benutzers darstellt.

Codieren

Ein Verweis auf einen code, der in einem Codierungssystem definiert ist.

Name Pfad Typ Beschreibung
Code
code string

Das vom System definierte Symbol in der Vom System definierten Syntax.

Display
display string

Eine Darstellung der Bedeutung des Codes in der menschlichen Sprache.

Extension
extension array of object

Zusätzliche Daten, die über Erweiterungen bereitgestellt werden.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für diese Codierungsinstanz.

System
system string

Die Identifizierung des Codesystems, das die Bedeutung des Symbols im Code definiert.

Benutzer ausgewählt
userSelected boolean

Gibt an, ob diese Codierung direkt vom Benutzer ausgewählt wurde.

Version
version string

Die Version des Codesystems, das zum Auswählen dieses Codes verwendet wurde.

ContactPoint

Details zu einem technologievermittelten Kontaktpunkt (Telefon, Fax, E-Mail usw.).

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzliche Daten, die über Erweiterungen bereitgestellt werden.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für diese Kontaktpunktinstanz.

Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Rang
rank integer

Gibt eine Einstellungsreihenfolge für diesen Kontaktpunkt an.

System
system string

Das System der technologievermittelten Kommunikation.

Verwendung
use string

Identifiziert den Zweck für diesen Kontaktpunkt.

Wert
value string

Die tatsächlichen Kontaktdaten, z. B. Telefonnummer oder E-Mail-Adresse.

HoursOfOperation

Gibt die Stunden an, in denen Vorgänge durchgeführt werden.

Name Pfad Typ Beschreibung
Den ganzen Tag
allDay boolean

Gibt an, ob der Dienst ganztäglich verfügbar ist.

Sperrstunde
closingTime string

Die Uhrzeit, zu der Vorgänge für den Tag enden.

Wochentage
daysOfWeek array of string

Die Wochentage, an denen Operationen durchgeführt werden.

Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für diese Betriebsstunden.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die die Betriebsstunden ändern.

items
modifierExtension object
Öffnungszeit
openingTime string

Die Uhrzeit, zu der Vorgänge für den Tag beginnen.

HumanName

Der Name eines Menschen mit der Möglichkeit, Teile und Verwendung zu identifizieren.

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
Familie
family string

Der Familienname (häufig als "Nachname" bezeichnet).

Gegeben
given array of string

Vornamen (nicht einschließlich familienname).

Id
id string

Ein eindeutiger Bezeichner für den menschlichen Namen.

Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Präfix
prefix array of string

Honorifics oder Titel vor dem Namen.

Nachsilbe
suffix array of string

Qualifizierer oder Titel nach dem Namen.

Text
text string

Textdarstellung des vollständigen Namens.

Verwendung
use string

Gibt den Zweck für diesen Namen an.

Kennung

Ein eindeutiger Bezeichner, der einer Entität zugewiesen ist.

Name Pfad Typ Beschreibung
Abtretende
assigner object

Die Organisation, die den Bezeichner ausgestellt hat.

Extension
extension array of object

Zusätzliche Daten für den Bezeichner.

items
extension object
Id
id string

Ein eindeutiger Bezeichner für die Id-Instanz.

Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

System
system string

Das System, das zum Zuweisen des Bezeichners verwendet wird.

type
type CodeableConcept

Ein Konzept, das durch einen formalen Verweis auf eine Terminologie oder Ontologie definiert werden kann oder von Text bereitgestellt werden kann.

Verwendung
use string

Die beabsichtigte Verwendung des Bezeichners.

Wert
value string

Der Wert des Bezeichners.

Standort

Informationen zu physischen Standorten, an denen Dienste bereitgestellt werden, und Ressourcen befinden sich.

Name Pfad Typ Beschreibung
address
address Address

Definiert einen physischen Speicherort anhand seiner Adresskomponenten.

Alias
alias array of string

Eine Liste mit alternativen Namen, die der Speicherort genannt wird oder in der Vergangenheit bekannt war.

Verfügbarkeits ausnahmen
availabilityExceptions string

Eine Beschreibung, wann der Speicherort nicht verfügbar ist.

Enthalten
contained array of Resource

Enthaltene Inlineressourcen.

Description
description string

Beschreibung des Orts, der beim Auffinden oder Verweisen auf den Ort hilft.

Endpunkt
endpoint array of object

Technische Endpunkte, die Zugriff auf Dienste bereitstellen, die für den Standort betrieben werden.

items
endpoint object
Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
hoursOfOperation
hoursOfOperation HoursOfOperation

Gibt die Stunden an, in denen Vorgänge durchgeführt werden.

Id
id string

Eindeutiger Bezeichner für die Location-Ressource.

Kennung
identifier array of Identifier

Eindeutiger Code oder eine eindeutige Nummer, der den Standort für seine Benutzer identifiziert.

Implizite Regeln
implicitRules string

Eine Reihe von Regeln, unter denen dieser Inhalt erstellt wurde.

Language
language string

Die Sprache des Ressourceninhalts.

Verwalten der Organisation
managingOrganization object

Die Organisation, die für die Bereitstellung und Denkeep des Standorts verantwortlich ist.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Modus
mode string

Gibt an, ob der Standort noch verwendet wird.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die nicht ignoriert werden können.

items
modifierExtension object
Name
name string

Name des Orts, der von Menschen verwendet wird.

operationalStatus
operationalStatus Coding

Ein Verweis auf einen code, der in einem Codierungssystem definiert ist.

Teil von
partOf object

Ein anderer Ort, von dem dieser Standort physisch teil ist.

physicalType
physicalType CodeableConcept

Ein Konzept, das durch einen formalen Verweis auf eine Terminologie oder Ontologie definiert werden kann oder von Text bereitgestellt werden kann.

Position
position Position

Die geografische Position eines Punkts.

Ressourcentyp
resourceType string

Der Typ der Ressource (Speicherort).

Der Status
status string

Der Status des Speicherorts (z. B. aktiv, angehalten, inaktiv).

Telecom
telecom array of ContactPoint

Kontaktdetails des Standorts.

Text
text Narrative

Eine lesbare Zusammenfassung der Ressource, die die wesentlichen klinischen und geschäftlichen Informationen für die Ressource vermittelt.

Typ
type array of CodeableConcept

Typ der Funktion, die an der Position ausgeführt wird.

LocationBundle

Eine Sammlung von "Location"-Ressourcen, die als Ergebnis eines Such-/Abfragevorgangs zurückgegeben wurden.

Name Pfad Typ Beschreibung
Entry
entry array of LocationEntry

Eine Liste der Einträge, die jeweils eine "Location"-Ressource kapseln.

Id
id string

Eindeutiger Bezeichner für das Bundle.

identifier
identifier Identifier

Ein eindeutiger Bezeichner, der einer Entität zugewiesen ist.

Implizite Regeln
implicitRules string

Ein Verweis auf die Regeln, unter denen das Bundle generiert wurde.

Language
language string

Die Sprache des Bundles.

Link
link array of BundleLink

Eine Reihe von Links, die den Kontext dieses Bündels bereitstellen.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Ressourcentyp
resourceType string

Der Typ der Ressource (Bundle).

Signatur
signature Signature

Eine digitale Signatur zusammen mit unterstützendem Kontext und Metadaten.

Zeitstempel
timestamp string

Das Datum/die Uhrzeit, zu dem das Bundle verfasst wurde.

Total
total integer

Die Gesamtanzahl der Ressourcen im Bundle.

Typ
type string

Der Typ des Bundles (z. B. Dokument, Suchmenge, Sammlung).

LocationEntry

Ein Eintrag in einem "LocationBundle"-Element, das eine "Location"-Ressource und zugehörige Informationen enthält.

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
Vollständige URL
fullUrl string

Die absolute URL, die das Ziel des Eintrags ist.

Id
id string

Eindeutiger Bezeichner für den Eintrag im Bundle.

Link
link array of BundleLink

Eine Reihe von Links im Zusammenhang mit dem Eintrag.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die den Eintrag ändern.

items
modifierExtension object
request
request Request

Eine Anforderungsressource innerhalb eines Bündels.

resource
resource Location

Informationen zu physischen Standorten, an denen Dienste bereitgestellt werden, und Ressourcen befinden sich.

response
response Response

Eine Antwortressource innerhalb eines Bündels.

search
search Search

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
Id
id string

Eindeutiger Bezeichner für die Metainstanz.

Zuletzt aktualisiert
lastUpdated string

Das letzte Mal, wenn die Ressource aktualisiert wurde.

Profile
profile array of string

Profile, die die Struktur und Verwendung der Ressource definieren.

Sicherheit
security array of Coding

Sicherheitstags für die Ressource.

Quelle
source string

Der Speicherort, an dem die Ressource generiert wurde.

Tag
tag array of Coding

Tags für die Ressource.

Versions-ID
versionId string

Die Version der Ressource.

Erzählung

Eine lesbare Zusammenfassung der Ressource, die die wesentlichen klinischen und geschäftlichen Informationen für die Ressource vermittelt.

Name Pfad Typ Beschreibung
Div
div string

Der XHTML-Inhalt der Erzählung.

Extension
extension array of object

Zusätzlicher Inhalt, der durch Erweiterungen definiert wird.

items
extension object
Id
id string

Eindeutiger Bezeichner für die Narrative-Instanz.

Der Status
status string

Der Status der Erzählinhaltsgenerierung.

Organization

Stellt eine Gruppe von Personen dar, die durch einen gemeinsamen Zweck definiert werden, z. B. ein Krankenhaus, eine Abteilung, ein Team oder eine Versicherungsgesellschaft.

Name Pfad Typ Beschreibung
Active
active boolean

Gibt an, ob die Organisation aktiv oder inaktiv ist.

address
address array of Address
Alias
alias array of string

Eine Liste mit alternativen Namen, von denen die Organisation bekannt ist oder in der Vergangenheit bekannt war.

Kontakt
contact array of OrganizationContact
enthalten
contained array of Resource
Endpunkt
endpoint array of object

Technische Endpunkte, die Zugriff auf elektronische Dienste bieten, die für die Organisation betrieben werden.

items
endpoint object
Extension
extension array of object

Erweiterungen für zusätzliche Informationen.

items
extension object
Id
id string

Eindeutiger Bezeichner für die Organisationsinstanz.

identifier
identifier array of Identifier
Implizite Regeln
implicitRules string

Ein Verweis auf die Regelsätze, unter denen diese Ressource erstellt wurde.

Language
language string

Die Sprache des Ressourceninhalts.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die die Ressource ändern.

items
modifierExtension object
Name
name string

Der Name der Organisation.

Teil von
partOf object

Die Organisation, von der diese Organisation Teil ist.

Ressourcentyp
resourceType string

Typ der Ressource (Organisation).

Telecom
telecom array of ContactPoint
Text
text Narrative

Eine lesbare Zusammenfassung der Ressource, die die wesentlichen klinischen und geschäftlichen Informationen für die Ressource vermittelt.

type
type array of CodeableConcept

OrganizationBundle

Name Pfad Typ Beschreibung
entry
entry array of OrganizationEntry
Kennung
id string

Der eindeutige Bezeichner für dieses Bündel.

identifier
identifier Identifier

Ein eindeutiger Bezeichner, der einer Entität zugewiesen ist.

Implizite Regeln
implicitRules string

Ein Verweis auf den Satz von Regeln, die auf das Bündel angewendet werden.

Language
language string

Die Sprache des Inhalts im Bundle.

link
link array of BundleLink
meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Ressourcentyp
resourceType string

Definiert den Typ der Ressource, in diesem Fall ein Bündel.

Signatur
signature Signature

Eine digitale Signatur zusammen mit unterstützendem Kontext und Metadaten.

Zeitstempel
timestamp string

Datum und Uhrzeit der Kompilierung des Bundles.

Total
total integer

Die Gesamtanzahl der Einträge im Bundle.

Typ
type string

Der Typ des Bündels, z. B. Dokument, Nachricht, Transaktion.

OrganizationContact

Ein Kontaktdetails für die Organisation.

Name Pfad Typ Beschreibung
address
address Address

Definiert einen physischen Speicherort anhand seiner Adresskomponenten.

Extension
extension array of object

Zusätzlicher Inhalt, der durch Implementierungen definiert wird.

items
extension object
Kennung
id string

Eindeutiger Bezeichner für den Organisationskontakt.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die nicht ignoriert werden können, auch wenn sie nicht erkannt werden.

items
modifierExtension object
name
name HumanName

Der Name eines Menschen mit der Möglichkeit, Teile und Verwendung zu identifizieren.

Zweck
purpose CodeableConcept

Ein Konzept, das durch einen formalen Verweis auf eine Terminologie oder Ontologie definiert werden kann oder von Text bereitgestellt werden kann.

Telecom
telecom array of ContactPoint

OrganizationEntry

Stellt einen Eintrag in einem Organisationsbundle dar.

Name Pfad Typ Beschreibung
Extension
extension array of object

Erweiterung für zusätzliche Informationen.

items
extension object
Vollständiges URL
fullUrl string

Die vollständige URL für die Ressource.

ID
id string

Der eindeutige Bezeichner für den Eintrag.

Link
link array of BundleLink

Eine Reihe von Links, die Kontext zu diesem Eintrag bereitstellen.

Modifizierererweiterung
modifierExtension array of object

Erweiterungen, die die Ressource ändern.

items
modifierExtension object
request
request Request

Eine Anforderungsressource innerhalb eines Bündels.

resource
resource Organization

Stellt eine Gruppe von Personen dar, die durch einen gemeinsamen Zweck definiert werden, z. B. ein Krankenhaus, eine Abteilung, ein Team oder eine Versicherungsgesellschaft.

response
response Response

Eine Antwortressource innerhalb eines Bündels.

search
search Search

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

Zeitraum

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Name Pfad Typ Beschreibung
ENDE
end string

Das Enddatum/die Endzeit des Zeitraums.

Extension
extension array of object

Zusätzliche Informationen oder Metadaten zum Zeitraum.

items
extension object
Id
id string

Eindeutiger Bezeichner für den Zeitraum.

Start
start string

Das Startdatum/die Startzeit des Zeitraums.

Position

Die geografische Position eines Punkts.

Name Pfad Typ Beschreibung
Höhe
altitude number

Die Höhe in Metern über dem Bezugsellipsoid.

Extension
extension array of object

Zusätzliche Informationen oder Metadaten zur Position.

items
extension object
Id
id string

Eindeutiger Bezeichner für die Position.

Breitengrad
latitude number

Der Breitengrad in Dezimalgrad (WGS 84).

Längengrad
longitude number

Der Längengrad in Dezimalgrad (WGS 84).

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten zur Position.

items
modifierExtension object

Praktizierender Arzt

Eine Person, die direkt oder indirekt an der Bereitstellung der Gesundheitsversorgung beteiligt ist.

Name Pfad Typ Beschreibung
Active
active boolean

Gibt an, ob der Arzt derzeit in der Gesundheitsversorgung tätig ist.

Adresse
address array of Address

Die Adresse(en), an die der Arzt kontaktiert oder besucht werden kann.

Geburtsdatum
birthDate string

Das Geburtsdatum des Arztes.

Communication
communication array of CodeableConcept

Eine Sprache, die der Arzt in der Patientenkommunikation verwenden kann.

Enthalten
contained array of Resource

In dieser Ressource enthaltene Ressourcen.

Erweiterungen
extensions array of object

Zusätzliche Informationen oder Metadaten über den Arzt.

items
extensions object
Geschlecht
gender string

Die Geschlechtsidentität des Arztes.

Id
id string

Eindeutiger Bezeichner für den Arzt.

Kennung
identifier array of Identifier

Eine Liste der Bezeichner des Arztes.

Implizite Regeln
implicitRules string

Ein Verweis auf eine Reihe von Regeln, die beim Erstellen der Ressource befolgt wurden.

Language
language string

Sprache, die der Arzt in der Patientenkommunikation verwenden kann.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Zusatzerweiterungen
modifierExtensions array of object

Zusätzliche Informationen oder Metadaten über den Arzt.

items
modifierExtensions object
Name
name array of HumanName

Die Namen, die dem Arzt zugeordnet sind.

Foto
photo array of Attachment

Ein Foto des Arztes.

Qualifikation
qualification array of PractitionerQualification

Durch Ausbildung und Zertifizierung erworbene Qualifikationen.

Ressourcentyp
resourceType string

Art der Ressource (Praktiker).

Telecom
telecom array of ContactPoint

Ein Kontaktdetail für den Arzt.

Text
text Narrative

Eine lesbare Zusammenfassung der Ressource, die die wesentlichen klinischen und geschäftlichen Informationen für die Ressource vermittelt.

PractitionerAvailableTime

Die Zeiten, in denen der Arzt für Termine zur Verfügung steht.

Name Pfad Typ Beschreibung
Den ganzen Tag
allDay boolean

Gibt an, ob der Arzt ganztäglich verfügbar ist.

Verfügbare Endzeit
availableEndTime string

Die Endzeit, die der Arzt für Termine zur Verfügung steht.

Verfügbare Startzeit
availableStartTime string

Die Startzeit, die der Arzt für Termine zur Verfügung steht.

Wochentage
daysOfWeek array of string

Die Wochentage, an denen der Arzt für Termine zur Verfügung steht.

Extension
extension array of object

Zusätzliche Informationen oder Metadaten zur Verfügbarkeit des Arztes.

items
extension object
Id
id string

Eindeutiger Bezeichner für die Verfügbarkeit des Arztes.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten zur Verfügbarkeit des Arztes.

items
modifierExtension object

Praktikerbundle

Ein Bündel von Ressourcen, die Informationen zu einem oder mehreren Praktikern enthalten.

Name Pfad Typ Beschreibung
Entry
entry array of PractitionerEntry

Ein Eintrag im Bündel – enthält eine Ressource oder Informationen zu einer Suche usw.

Id
id string

Eindeutiger Bezeichner für das Bundle.

identifier
identifier Identifier

Ein eindeutiger Bezeichner, der einer Entität zugewiesen ist.

Implizite Regeln
implicitRules string

Ein Verweis auf eine Reihe von Regeln, die beim Erstellen der Ressource befolgt wurden.

Language
language string

Sprache des Ressourceninhalts.

Link
link array of BundleLink

Links zu diesem Bundle.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Ressourcentyp
resourceType string

Typ der Ressource (Bundle).

Signatur
signature Signature

Eine digitale Signatur zusammen mit unterstützendem Kontext und Metadaten.

Zeitstempel
timestamp string

Als das Bündel zusammengebaut wurde.

Total
total integer

Bei suche, die Gesamtanzahl der Übereinstimmungen.

Typ
type string

Der Typ der Ressource.

Praktikerin

Ein Eintrag im Bündel, der Informationen über einen Arzt enthält.

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzliche Informationen oder Metadaten zum Eintrag des Arztes.

items
extension object
Vollständiges URL
fullUrl string

Die URL des Eintrags.

ID
id string

Eindeutiger Bezeichner für den Arzteintrag.

Link
link array of BundleLink

Links zu diesem Arzteintrag.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten zum Eintrag des Arztes.

items
modifierExtension object
request
request Request

Eine Anforderungsressource innerhalb eines Bündels.

resource
resource Practitioner

Eine Person, die direkt oder indirekt an der Bereitstellung der Gesundheitsversorgung beteiligt ist.

response
response Response

Eine Antwortressource innerhalb eines Bündels.

search
search Search

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

PractitionerNotAvailable

Die Zeiten, in denen der Arzt nicht für Termine verfügbar ist.

Name Pfad Typ Beschreibung
Description
description string

Eine Beschreibung, warum der Arzt nicht verfügbar ist.

während
during Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Extension
extension array of object

Zusätzliche Informationen oder Metadaten über die Unverfügbarkeit des Arztes.

items
extension object
ID
id string

Eindeutiger Bezeichner für die Unverfügbarkeit des Arztes.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten über die Unverfügbarkeit des Arztes.

items
modifierExtension object

Praktikerqualifizierung

Die Vom Arzt gehaltenen Qualifikationen oder Zertifizierungen.

Name Pfad Typ Beschreibung
Code
code CodeableConcept

Ein Konzept, das durch einen formalen Verweis auf eine Terminologie oder Ontologie definiert werden kann oder von Text bereitgestellt werden kann.

Extension
extension array of object

Zusätzliche Informationen oder Metadaten zur Qualifikation des Arztes.

items
extension object
ID
id string

Eindeutiger Bezeichner für die Qualifikation des Arztes.

Kennung
identifier array of Identifier

Bezeichner, die mit der Qualifikation des Arztes verbunden sind.

Emittent
issuer object

Die Entität, die die Qualifikation ausgestellt hat.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten zur Qualifikation des Arztes.

items
modifierExtension object
Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

PractitionerRole

Definiert die Rolle eines Arztes innerhalb einer Organisation oder Praxis im Gesundheitswesen.

Name Pfad Typ Beschreibung
Active
active boolean

Gibt an, ob die Rolle dieses Arztes derzeit aktiv ist.

Verfügbarkeits ausnahmen
availabilityExceptions string

Weitere Informationen zur Verfügbarkeit der Rolle dieses Arztes, falls zutreffend.

Verfügbare Zeit
availableTime array of PractitionerAvailableTime

Die Zeiten, in denen dieser Arzt für Termine oder andere Dienstleistungen zur Verfügung steht.

Code
code array of CodeableConcept

Der Code(n), der die Art der erfüllten Rolle des Gesundheitswesens identifiziert.

Enthalten
contained array of Resource

Verwandte Ressourcen, die inline innerhalb der Ressource definiert sind.

Endpunkt
endpoint array of object

Die technischen Endpunkte, die Zugriff auf dienste bieten, die für den Praktiker betrieben werden.

items
endpoint object
Extension
extension array of object

Zusätzlicher Inhalt, der durch Implementierungen definiert wird.

items
extension object
Gesundheitswesen
healthcareService array of object

Die Gesundheitsdienste, die dieser Arzt für die Organisation oder Praxis bereitstellt.

items
healthcareService object
ID
id string

Der logische Bezeichner für diese Praxisrolle.

Kennung
identifier array of Identifier

Die eindeutigen Bezeichner für diese Praxisrolle im Kontext eines bestimmten Systems.

Implizite Regeln
implicitRules string

Ein Verweis auf eine Reihe von Regeln, die beim Erstellen der Ressource befolgt wurden und die beim Verarbeiten des Inhalts verstanden werden müssen.

Language
language string

Die Basissprache, in der die Ressource geschrieben wird.

Standort
location array of object

Der Ort(n), an dem dieser Arzt Dienstleistungen anbietet.

items
location object
meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Inhalte, die durch Implementierungen definiert werden, die den Inhalt der Ressource auf irgendeine Weise ändern.

items
modifierExtension object
Nicht verfügbar.
notAvailable array of PractitionerNotAvailable

Die Zeiten, in denen dieser Arzt nicht für Termine oder andere Dienstleistungen verfügbar ist.

Organization
organization object

Die Organisation oder der Gesundheitsdienst, in der diese Rolle definiert ist.

Zeitraum
period Period

Ein Zeitraum, der durch Start- und Enddatums-/Uhrzeitgrenzen beschrieben wird.

Praktizierender Arzt
practitioner object

Der Arzt, der für die von dieser Rolle bereitgestellten Dienstleistungen verantwortlich ist.

Ressourcentyp
resourceType string

Eine Art von Ressource, die zusammen mit anderen Ressourcen identifizierbar ist.

Spezialität
specialty array of CodeableConcept

Spezifische Spezialleistungen des Praktikers im Rahmen dieser Rolle.

Telecom
telecom array of ContactPoint

Kontaktdaten für die Rolle des Arztes.

Text
text Narrative

Eine lesbare Zusammenfassung der Ressource, die die wesentlichen klinischen und geschäftlichen Informationen für die Ressource vermittelt.

PractitionerRoleBundle

Ein Bündel von Praktischen Rollenressourcen, die in der Regel verwendet werden, um einen vollständigen Satz von Suchergebnissen oder eine Teilmenge von Ressourcen in einer paginierten Liste bereitzustellen.

Name Pfad Typ Beschreibung
Entry
entry array of PractitionerRoleEntry

Ein Eintrag im Bündel – verfügt über eine Ressource oder Informationen zu einer Ressource.

ID
id string

Der logische Bezeichner für dieses Bündel.

identifier
identifier Identifier

Ein eindeutiger Bezeichner, der einer Entität zugewiesen ist.

Implizite Regeln
implicitRules string

Ein Verweis auf eine Reihe von Regeln, die beim Erstellen des Bundles befolgt wurden und die beim Verarbeiten des Inhalts verstanden werden müssen.

Language
language string

Die Basissprache, in der die Ressource geschrieben wird.

Link
link array of BundleLink

Eine Reihe von Links, die Kontext zu diesem Bundle bereitstellen.

meta
meta Meta

Metadaten zu einer Ressource, einschließlich Version, Profil und Sicherheit.

Ressourcentyp
resourceType string

Eine Art von Ressource, die zusammen mit anderen Ressourcen identifizierbar ist.

Signatur
signature Signature

Eine digitale Signatur zusammen mit unterstützendem Kontext und Metadaten.

Zeitstempel
timestamp string

Die Zeit, zu der das Bündel zusammengestellt wurde.

Total
total integer

Die Gesamtanzahl der Einträge im Bundle.

Typ
type string

Der Typ des Bündels – gibt an, ob es sich um ein Dokument, eine Nachricht, eine Transaktion usw. handelt.

PractitionerRoleEntry

Ein Eintrag in einem Bündel vom Typ "PractitionerRole", der Informationen über die Rolle eines Arztes enthält.

Name Pfad Typ Beschreibung
Extension
extension array of object

Zusätzliche Informationen oder Metadaten zum Eintrag.

items
extension object
Vollständiges URL
fullUrl string

Die vollständige URL der Ressource im Eintrag.

ID
id string

Eindeutiger Bezeichner für den Eintrag.

Link
link array of BundleLink

Links zu diesem Eintrag.

Modifizierererweiterung
modifierExtension array of object

Zusätzliche Informationen oder Metadaten zum Eintrag.

items
modifierExtension object
request
request Request

Eine Anforderungsressource innerhalb eines Bündels.

resource
resource PractitionerRole

Definiert die Rolle eines Arztes innerhalb einer Organisation oder Praxis im Gesundheitswesen.

response
response Response

Eine Antwortressource innerhalb eines Bündels.

search
search Search

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

Anfrage

Eine Anforderungsressource innerhalb eines Bündels.

Name Pfad Typ Beschreibung
object

Eine Anforderungsressource innerhalb eines Bündels.

Resource

Eine FHIR-Ressource, die ein einzelnes kohärentes Konzept oder Vorkommen einer Sache darstellt.

Name Pfad Typ Beschreibung
object

Eine FHIR-Ressource, die ein einzelnes kohärentes Konzept oder Vorkommen einer Sache darstellt.

Antwort

Eine Antwortressource innerhalb eines Bündels.

Name Pfad Typ Beschreibung
object

Eine Antwortressource innerhalb eines Bündels.

Suche

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

Name Pfad Typ Beschreibung
object

Eine Ressource, die einen Suchvorgang oder eine Suchfunktion darstellt.

Signature

Eine digitale Signatur zusammen mit unterstützendem Kontext und Metadaten.

Name Pfad Typ Beschreibung
Daten
data string

Der base64-codierte Signaturinhalt.

Extension
extension array of object

Zusätzliche Informationen, die durch Implementierungen definiert sind.

items
extension object
Id
id string

Der eindeutige Bezeichner für diese Signatur.

Im Auftrag von
onBehalfOf object

Die Partei, die durch diese Unterschrift vertreten ist.

Signaturformat
sigFormat string

Das technische Format des Signaturinhalts.

Zielformat
targetFormat string

Das technische Format des signierten Inhalts.

Typ
type array of Coding

Die Codierung, die den Zweck der Signatur darstellt.

Wann
when string

Beim Erstellen der Signatur.

Wer
who object

Für wen diese Signatur gilt.