Interaktionen

InteraktionHinweiseVerbindlichkeit
read

Sofern die Ressource Organization unterstützt wird, SOLL die REST-Interaktion read implementiert werden.

SHOULD
search-type

Sofern die Ressource Organization unterstützt wird, SOLL die REST-Interaktion search implementiert werden.

SHOULD
ParameterTypVerbindlichkeitHinweise
_idtokenSHALL

Beispiel:
GET [base]/[Resourcetype]?_id=103270
Anwendungshinweis:
Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

_tagtokenSHALL

Beispiel:
GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

_countnumberSHALL

Beispiel:
GET [base]/[Resourcetype]?_count=100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

_hasstringMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
GET [base]/Patient?_has:Observation:patient:code=1234-5
Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
GET [base]/Encounter?_has:Condition:encounter:code=A12.3
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

identifiertokenSHALL

Beispiel:
GET [base]/Organization?identifier=http://fhir.de/sid/arge-ik/iknr|260120196 GET [base]/Organization?identifier=http://fhir.de/StructureDefinition/identifier-bsnr|345678975 GET [base]/Organization?identifier=345678975
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

activetokenSHALL

Beispiel:
GET [base]/Organization?active=true GET [base]/Organization?active=false
Anwendungshinweis:
Insbesondere für die Suche nach Daten historischer Organisationsstrukturen - z.B. nach Schließung, Zusammenlegung von Fachabteilungen etc. - erscheint es erforderlich nach Ressourcen nicht aktiver Organisationseinheiten suchen zu können. Weitere Details siehe FHIR-Kernspezifikation.

typetokenSHALL

Beispiel:
GET [base]/Organization?type=dept
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

namestringSHALL

Beispiel:
GET [base]/Organization?name=FA-Gynäkologie
GET [base]/Organization?name=GYN
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

addressstringMAY

Beispiel:
GET [base]/Organization?address=Berlin
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

partofreferenceSHALL

Beispiel:
GET [base]/Organization?partof:identifier=260120196
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

endpointreferenceMAY

Beispiel:
GET [base]/Organization?endpoint:identifier=123456
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

(Reverse-)Include