Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Data of a specific organization may be fetched using a read request including the identifier of the specific organization. A read request returns one FHIR item of type KBV_PR_AW_Betriebsstaette. A read requesrt for an organization specifies the organization by its organization ID. The organization ID may be fetched by a previous search request.

Code Block
{{baseURL}}/{{tenant}}/Organization/id

...

{{OrganizationId}}


Claims

...

A claim represents a chargecode for statutory or private billing (Leistungsziffer EBM oder GOÄ). Claims are assigned to a patient and may be searched for using a search request.

...

titleExample for a SEARCH request for all claims of a patient

If the search request contains pagination but no patient reference it will return all claims stored in RED. In order to retrieve all claims for a given person the patient ID must be added. The patient ID is either defined by the 3rd-party-system when creating a patient via POST request (see below) or must be retrieved by a previous search.

Code Block
titleExample for a SEARCH request for all claims of a given patient
{{baseURL}}/{{tenant}}/Claim?page=1&patient=Patient/6006{{patientID}}



Encounters

Encounters

...

Search can also be used to search for items assigned to a patient by adding the patient identifier to the search request.

SEARCH DocumentReference 

This request will return a FHIR bundle containing all documents stored for a given patient. Returns represent a patient visit or consultation. Each time a patient record is created for a patient there will be corresponding encounter. Encounters are assignetd to a patient and may be searched.

Code Block
titleExample for a SEARCH request for all encounters of a given patient
{{baseURL}}/{{tenant}}/Encounter?page=1&subject=Patient/{{patientID}}


Diagnoses

ICD-10 patient diagnoses are represented by conditions. 

Code Block
titleExample for a SEARCH for all diagnoses for a given patient
{{baseURL}}/{{tenant}}/Condition?page=1&subject=Patient/{{patientID}}


Medication

Medication returns all pharmaceuticals prescribed or documented for a patient.

Code Block
{{baseURL}}/{{tenant}}/Medication?page=1&subject=Patient/{{patientID}}


Document References

Document references are

  • document files that have been uploaded and stored in RED (e.g. pdf files created by a scan and uploaded in RED)
  • forms created in RED (e.g. Überweisung, AU etc.). All Forms will be returned as PDF files regardless of whether a printout has been created or not → Erlkönig - Formulardruck
  • letters created for patients - Erlkönig - Briefe

A SEARCH request for document references returns a bundle of one or more FHIR items of type DocumentReference.> GET http://localhost:29221/{tenant

Code Block
titleExample for a SEARCH request for all documents of given patient
{{baseURL}}/{{tenant}}/DocumentReference?page=1&subject=Patient/{{

...

patientID}}

For each document found the FHIR bundle includes the base64-encoded document content. To avoid long loading time the request can be modified with the summary option to fetch the document metadata without the actual document content. > GET http://localhost:29221/

Code Block
{{baseURL}}/{{tenant}}/DocumentReference?page=1&subject=Patient/{

...

{patientID}}&_summary=true

...

SEARCH Conditions

This request will return a FHIR bundle containing all conditions (diagnoses) stored for a given patient. Returns a bundle of one or more FHIR items of type condition.

...


Get data items

While search retrieves all data matching the given search criteria (e.g. a patient) specific items can be retrieved by adding their identification to the GET request.

...